Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
push:
branches:
- main
workflow_dispatch:

concurrency: ${{ github.workflow }}-${{ github.ref }}

Expand Down Expand Up @@ -186,3 +187,51 @@ jobs:
-H "Content-Type: application/zip" \
"https://uploads.github.com/repos/${{ github.repository }}/releases/${{ steps.get-release-id.outputs.id }}/assets?name=${{ steps.package-artifact.outputs.archive }}" \
--data-binary "@generated/${{ steps.package-artifact.outputs.archive }}"

publish-docs:
needs: [release]
if: ${{ needs.release.outputs.published == 'true' }}
permissions:
contents: read
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0

- uses: pnpm/action-setup@v4
name: Install pnpm
with:
run_install: false

- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: 22
cache: pnpm

- name: Install dependencies
env:
SKIP_RUST_BUILD: 1
run: pnpm install --frozen-lockfile

- name: Build docs
run: pnpm run build:docs

- name: Setup Pages
uses: actions/configure-pages@v5

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: 'docs'

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
name: Build and publish docs
name: Test docs publishing

on:
release:
types: [published]

workflow_dispatch:

permissions:
Expand All @@ -12,17 +9,20 @@ permissions:
id-token: write

concurrency:
group: 'github-pages'
group: 'github-pages-test'
cancel-in-progress: false

jobs:
deploy:
publish-docs:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0

- uses: pnpm/action-setup@v4
name: Install pnpm
Expand All @@ -40,25 +40,17 @@ jobs:
SKIP_RUST_BUILD: 1
run: pnpm install --frozen-lockfile

- name: Generate TypeDoc markdown (without modifying repo)
run: |
pnpm run build:docs
rm -rf docs-typedoc
- name: Build docs
run: pnpm run build:docs

- name: Setup Pages
uses: actions/configure-pages@v5

- name: Build with Jekyll
uses: actions/jekyll-build-pages@v1
with:
source: ./docs

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload the built site for deployment
path: '_site'
path: 'docs'

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
uses: actions/deploy-pages@v4
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ npm-debug.log
yarn-error.log
testem.log
/typings
CLAUDE.md

# System Files
.DS_Store
Expand Down Expand Up @@ -81,3 +82,6 @@ index.node
npm-debug.log*
cargo.log
cross.log

# Generated documentation
/docs
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,18 @@ This command will download precompiled binaries for the following systems:
- Windows x86
- Windows ARM

## Documentation

Complete API documentation is generated from TypeScript source using [TypeDoc](https://typedoc.org/) and published to GitHub Pages at [https://contentauth.github.io/c2pa-node-v2/](https://contentauth.github.io/c2pa-node-v2/).

To generate documentation locally:

```bash
pnpm build:docs
```

This generates HTML documentation in the `docs/` directory. The `docs/` directory is not checked into version control. It's automatically generated and published to GitHub Pages whenever a new release is published.

## Components

### Reader
Expand Down
9 changes: 0 additions & 9 deletions docs/.gitignore

This file was deleted.

25 changes: 0 additions & 25 deletions docs/404.html

This file was deleted.

34 changes: 0 additions & 34 deletions docs/Gemfile

This file was deleted.

12 changes: 0 additions & 12 deletions docs/README.md

This file was deleted.

32 changes: 0 additions & 32 deletions docs/_config.yml

This file was deleted.

1 change: 0 additions & 1 deletion docs/_includes/custom-head.html

This file was deleted.

29 changes: 0 additions & 29 deletions docs/_includes/footer.html

This file was deleted.

10 changes: 0 additions & 10 deletions docs/_includes/head.html

This file was deleted.

16 changes: 0 additions & 16 deletions docs/_includes/header.html

This file was deleted.

8 changes: 0 additions & 8 deletions docs/_includes/nav-items.html

This file was deleted.

10 changes: 0 additions & 10 deletions docs/_includes/sidebar.html

This file was deleted.

4 changes: 0 additions & 4 deletions docs/_includes/sub-footer.html

This file was deleted.

29 changes: 0 additions & 29 deletions docs/_layouts/base.html

This file was deleted.

Loading
Loading