Repository navigation
Improve changelog agent: prerelease support, formatting fixes, publish trigger - #641
Conversation
d454b74 to
1f47e97
Compare
There was a problem hiding this comment.
Pull request overview
Improves the GitHub Agentic Workflow that generates release changelogs/release notes, extending it to handle prereleases and fixing formatting/triggering so it can be reliably invoked from the publish workflow.
Changes:
- Switch release-changelog workflow to
workflow_dispatch-only and update the agent prompt for stable vs prerelease behavior. - Update compiled
release-changelog.lock.ymlaccordingly (inputs wiring, removal ofrelease: publishedand pre-activation gating). - Trigger the changelog workflow from
publish.ymlafter creating a GitHub Release/Pre-Release.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| .github/workflows/release-changelog.md | Updates agent instructions for prerelease handling and formatting tweaks; switches to workflow_dispatch input. |
| .github/workflows/release-changelog.lock.yml | Regenerated lock workflow to match the updated .md definition and new dispatch-only trigger model. |
| .github/workflows/publish.yml | Adds a step to dispatch the changelog workflow after release creation. |
| - name: Trigger changelog generation | ||
| run: gh workflow run release-changelog.lock.yml -f tag="v${{ needs.version.outputs.version }}" | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
There was a problem hiding this comment.
gh workflow run uses the Actions/Workflow Dispatch API and typically requires the token to have actions: write permission. This workflow only grants contents: write and id-token: write, so this step is likely to fail with a 403. Add actions: write to the workflow/job permissions (or use a PAT with sufficient scope) so the dispatch succeeds.
There was a problem hiding this comment.
Fixed — added actions: write to publish.yml permissions.
| description: Generates a changelog from merged PRs/commits when a release is published, and updates the GitHub Release notes. For stable releases, also opens a PR to update CHANGELOG.md. | ||
| on: | ||
| release: | ||
| types: [published] | ||
| workflow_dispatch: |
There was a problem hiding this comment.
The workflow is now invoked only via workflow_dispatch, but the description still says it runs "when a release is published". This is misleading in the Actions UI; consider updating the description to reflect that it’s triggered via workflow_dispatch (and/or by the publish workflow) rather than a release event.
There was a problem hiding this comment.
Fixed — updated description to reflect it's triggered via workflow_dispatch / the publish workflow.
…h trigger - Support prerelease releases: update GitHub Release notes only (no CHANGELOG.md or PR) - Stable releases: update both CHANGELOG.md (via PR) and GitHub Release notes - Don't include version heading in GitHub Release notes (redundant with release title) - Omit 'Other changes' subheading when there are no highlighted features - Add 'New contributors' section for first-time contributors - Trigger changelog workflow from publish.yml for both latest and prerelease - Remove release:published trigger (GITHUB_TOKEN events don't trigger other workflows) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1f47e97 to
9f07aab
Compare
…h trigger (#641) - Support prerelease releases: update GitHub Release notes only (no CHANGELOG.md or PR) - Stable releases: update both CHANGELOG.md (via PR) and GitHub Release notes - Don't include version heading in GitHub Release notes (redundant with release title) - Omit 'Other changes' subheading when there are no highlighted features - Add 'New contributors' section for first-time contributors - Trigger changelog workflow from publish.yml for both latest and prerelease - Remove release:published trigger (GITHUB_TOKEN events don't trigger other workflows) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Follow-up improvements to the release changelog agent:
Prerelease support
Formatting fixes (from test run feedback)
### Other changessubheading when there are no highlighted features above it### New contributorssection listing first-time contributors with their PR linkTrigger fix
workflow_dispatchfor bothlatestandprerelease(replacesrelease: publishedtrigger which doesn't fire fromGITHUB_TOKENevents)Supersedes #640.