Skip to content

ci(release): trigger the API docs release after publishing to npm #225

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

Draft
ChronosSF wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

ci(release): trigger the API docs release after publishing to npm #225

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
31 changes: 31 additions & 0 deletions .github/workflows/npm-publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,37 @@ jobs:
artifacts/*.cdx.json \
$(ls attestations/*.json 2>/dev/null || true)

# Hands the release to IgniteUI/api-docs, which decides where its API docs go: every X.Y.0 and
# pre-release to staging, and an X.Y.0 to production once staging has it. Patches are deployed by
# hand. Gated by the npmjs.org publish, so docs never go out for a release that isn't on npm, and
# skipped for workflow_dispatch test runs.
dispatch-api-docs:
name: Release the API docs
needs: publish-npmjs
if: github.event_name == 'release'
runs-on: ubuntu-latest
timeout-minutes: 10
permissions: {}

steps:
- name: Get app token
id: app-token
uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510 # v3.3.0
with:
client-id: ${{ secrets.IGNITEUI_GITHUB_APP_CLIENT_ID }}
private-key: ${{ secrets.IGNITEUI_GITHUB_APP_PRIVATE_KEY }}
owner: IgniteUI
repositories: api-docs
permission-actions: write

# The deploy runs in api-docs, which opens an issue there if it fails.
- name: Trigger the API docs release
env:
GH_TOKEN: ${{ steps.app-token.outputs.token }}
run: >-
gh workflow run release-api-docs.yml --repo IgniteUI/api-docs --ref master
-f product=igniteui-react -f version="$VERSION"

# Builds and inventories the licensed (@infragistics-scoped) release for the ProGet feed.
# Holds no publishing rights.
build-proget:
Expand Down
Loading