Skip to content

Conversation

@seanlanglands
Copy link
Contributor

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.yml and publish-docs.yml workflows 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) and GITHUB_TOKEN is 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.yml to ensure they are run when the publish job is successful. If this job is skipped, the docs-related workflows are not run.

Pull request checklist

New release checklist

@seanlanglands seanlanglands requested a review from a team November 14, 2025 21:19
@github-actions
Copy link
Contributor

github-actions bot commented Nov 14, 2025

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@sjinks sjinks changed the title Fix/docs workflow trigger ci: update docs workflow triggers Nov 17, 2025
@sjinks sjinks requested a review from Copilot November 17, 2025 07:48
Copy link
Contributor

Copilot AI left a 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.yml and changelog.yml triggers from release: [published] and push: tags to workflow_run based triggers
  • Added two new jobs (changelog and publish-docs) in npm-publish.yml that 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.

@sjinks
Copy link
Member

sjinks commented Nov 17, 2025

@seanlanglands, could you please check Copilot's comments?

@sonarqubecloud
Copy link

@seanlanglands
Copy link
Contributor Author

@sjinks, that's now fixed. I switched to using workflow_call and re-tested this workflow setup on a test repo.

@sjinks sjinks merged commit fbbd26d into trunk Nov 17, 2025
19 checks passed
@sjinks sjinks deleted the fix/docs-workflow-trigger branch November 17, 2025 21:43
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.

3 participants