-
Notifications
You must be signed in to change notification settings - Fork 19
ci: update docs workflow triggers #2626
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.
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
Conversation
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This pull request updates the workflow triggers to ensure changelogs and documentation are published after successful npm releases. The changes address a limitation where workflows triggered by GitHub releases created programmatically via GITHUB_TOKEN do not spawn subsequent workflow runs.
Key changes:
- Changed
publish-docs.ymlandchangelog.ymltriggers fromrelease: [published]andpush: tagstoworkflow_runbased triggers - Added two new jobs (
changelogandpublish-docs) innpm-publish.ymlthat directly invoke the documentation workflows - Updated job and workflow naming for consistency
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
.github/workflows/npm-publish.yml |
Adds two new jobs that invoke changelog and publish-docs workflows after successful publish |
.github/workflows/publish-docs.yml |
Changes trigger from tag push to workflow_run, adds job name |
.github/workflows/changelog.yml |
Changes trigger from release published to workflow_run, updates workflow and job names |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@seanlanglands, could you please check Copilot's comments? |
|
|
@sjinks, that's now fixed. I switched to using |



Description
This pull request updates workflows to ensure changelogs and documentation are published. The main changes involve triggering these workflows after a successful npm publish, ensuring that changelogs and documentation are kept in sync with releases.
Why didn't this work before?
Both the
changelog.ymlandpublish-docs.ymlworkflows were configured to trigger on a new GitHub release being published. However, since the release is created programmatically via GitHub's API in another workflow (npm-publish.yml) andGITHUB_TOKENis used, the event does not create subsequent workflow runs.RE: https://docs.github.com/en/actions/how-tos/write-workflows/choose-when-workflows-run/trigger-a-workflow#triggering-a-workflow-from-a-workflow
Now, both docs-related workflows are invoked directly in
npm-publish.ymlto ensure they are run when thepublishjob is successful. If this job is skipped, the docs-related workflows are not run.Pull request checklist
New release checklist