Skip to content

ci: publish the API reference from the release workflow #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dazzatronus merged 1 commit into from
Sep 18, 2026
Merged

ci: publish the API reference from the release workflow #139

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
56 changes: 56 additions & 0 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,59 @@ jobs:
echo "::error::Failed to dispatch to ${repo} after 3 attempts"
fi
done

docs:
name: Publish API reference
needs: release
# Skips rather than fails until the deploy role exists as a repository variable.
if: vars.AWS_DOCS_DEPLOY_ROLE_ARN != ''
runs-on: ubuntu-latest
permissions:
contents: read
id-token: write
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup pnpm
uses: pnpm/action-setup@v4
with:
version: 9

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version-file: '.nvmrc'
cache: 'pnpm'

- name: Install dependencies
run: pnpm install --frozen-lockfile

# shins' devDependencies pull in node-sass, which no longer compiles on current Node.
# The docs build only needs the runtime deps; the compiled CSS is committed.
- name: Install shins
working-directory: .shins
run: npm ci --omit=dev --no-audit --no-fund

# build-docs.sh splices .tags into <head> and removes the placeholder only when the file exists.
- name: Provide empty head tags
run: ': > .tags'

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

- name: Configure AWS credentials
uses: aws-actions/configure-aws-credentials@v4
with:
role-to-assume: ${{ vars.AWS_DOCS_DEPLOY_ROLE_ARN }}
aws-region: ap-southeast-2

- name: Sync to S3
run: aws s3 sync build/docs/ s3://shotstack.io/docs/api --delete

- name: Invalidate CloudFront
if: vars.DOCS_CLOUDFRONT_DISTRIBUTION_ID != ''
run: >
aws cloudfront create-invalidation
--distribution-id "${{ vars.DOCS_CLOUDFRONT_DISTRIBUTION_ID }}"
--paths '/docs/api/*'
Loading