Skip to content

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

Draft
ChronosSF wants to merge 1 commit into
masterfrom
sstoychev/release-api-docs
Draft

ChronosSF wants to merge 1 commit into
masterfrom
sstoychev/release-api-docs

Conversation

@ChronosSF

@ChronosSF ChronosSF commented Nov 2, 2026 •

Copy link
Copy Markdown
Member

Closes IgniteUI/api-docs#250.

The API docs are deployed by hand after each release today.

Adds a dispatch-api-docs job to npm-publish.yml. Once the packages are on npmjs.org, it starts Release API Docs in IgniteUI/api-docs, added in IgniteUI/api-docs#219, with product=igniteui-react and the release tag. api-docs then decides where the API docs go:

Release Staging Production
X.Y.0 yes yes, once staging is deployed
pre-release (-beta.N, -rc.N) yes never
patch (X.Y.Z, Z > 0) by hand by hand
  • It runs only for releases, like attach-release-npmjs, so workflow_dispatch test runs don't deploy docs.
  • It doesn't wait for the ProGet publish, which the API docs don't use.
  • The job only starts that run; the release doesn't wait for the docs. If the docs fail to deploy, api-docs opens an issue there, "API docs release failed: igniteui-react <version>". This job fails only if the dispatch itself does.
  • The token comes from the IgniteUI GitHub App, scoped to api-docs with actions: write. The secrets are org secrets this repo already has.

Draft until:

  • IgniteUI/api-docs#219 is merged and released to api-docs' master. Until then GitHub can't find the workflow, so this job would fail on every release.
  • The IgniteUI GitHub App has Actions: write on api-docs. I couldn't check this without org admin rights. Without it, "Get app token" fails.

Testing:

  • actionlint finds nothing in the new job. What it reports elsewhere in the file is a shellcheck warning already on master.
  • Not run end to end yet, since that needs IgniteUI/api-docs#219 on api-docs' master. The rules above are tested there.

Additional information (check all that apply):

  • Bug fix
  • New functionality
  • Documentation
  • Demos
  • CI/CD

🤖 Generated with Claude Code

Once the packages are on npm, dispatch Release API Docs in
IgniteUI/api-docs with the product and the released version. api-docs
decides where the docs go: every X.Y.0 and pre-release to staging, an
X.Y.0 to production once staging has it, and patches only by hand.

The job uses the IgniteUI GitHub App's token, scoped to api-docs with
actions: write. It can't run until IgniteUI/api-docs#219 is on
api-docs' master.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-code-quality

Copy link
Copy Markdown

Code coverage overview

Languages: TypeScript

TypeScript / React Wrappers

master b0a4d5b sstoychev/release-ap... 26757cc +/-
98% 98% 0%

ℹ️ Calculations represent line coverage. Results may change as calculations are updated.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant