You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: resolve changelog link and automate changelog updates for #253 - #254
- Fix broken CHANGELOG.md link: /main/ → /master/ in mkdocs.yml and docs/community.md
- Update CHANGELOG.md with comprehensive entries for v0.2.1, v0.2.2, and v0.2.3
- Each entry includes summary, Added, Fixed, Documentation, and Changed sections
- Links to compare view of each release
- Create GitHub Actions workflow (update-changelog.yml) that:
- Triggers when a release is published (draft → published)
- Extracts release notes and formats them for Keep a Changelog
- Creates a PR to update CHANGELOG.md for review before merge
Resolves#253
boscorat
linked an issue
Oct 7, 2026
that may be
closed
by this pull request
The reason will be displayed to describe this comment to others. Learn more.
🟡 Changes recommended
The new workflow interpolates untrusted release text directly into a shell script (injection + multi-line breakage) and grants only contents: read, which blocks the create-pull-request step it depends on.
This PR resolves issue #253 by fixing broken /main/ GitHub links (the repo uses the master branch), back-filling the CHANGELOG.md with the v0.2.1–v0.2.3 releases, and adding a GitHub Actions workflow that opens a changelog-update PR whenever a release is published. It improves documentation accuracy and reduces manual release-note maintenance.
Changes:
Corrected changelog/contributing links from /blob/main/ to /blob/master/ in mkdocs.yml and docs/community.md (repo-wide /main/ links are now fully cleaned up, and compare-link tags all exist).
Added structured ## [0.2.3] / [0.2.2] / [0.2.1] entries with summaries, sections, and valid GitHub compare links to CHANGELOG.md.
Added .github/workflows/update-changelog.yml to auto-generate a changelog PR on release publish.
File
Description
mkdocs.yml
Fix Changelog nav link to use the master branch.
docs/community.md
Fix CONTRIBUTING.md link to use the master branch.
CHANGELOG.md
Add v0.2.1–v0.2.3 release entries with compare links.
.github/workflows/update-changelog.yml
New release-triggered workflow that opens a changelog-update PR (has a script-injection/multiline bug and insufficient permissions).
Pull requests created by peter-evans/create-pull-request using the default secrets.GITHUB_TOKEN do not trigger other workflows (on: push / on: pull_request) — this is an intentional GitHub safeguard against recursive runs. Since CI (ci.yml) and the docs build run on pull_request: branches: [master], the auto-generated changelog PR will have no status checks, so it cannot be merged automatically if master's branch protection requires those checks to pass. Consider using a dedicated PAT or GitHub App token for the token input (and the checkout) so the created PR runs the required checks.
🧠 Review effort: Balanced
Give feedback about Copilot approvals in this survey to enter a drawing for a $150 gift card.
The reason will be displayed to describe this comment to others. Learn more.
🟡 Changes recommended
The automation relies on a GITHUB_TOKEN-created PR that won't trigger required CI on protected master, plus a changelog duplicate and an unhardened shell interpolation that should be addressed.
Duplicate changelog entry for organization JSON-LD schema
CHANGELOG.md:105
This entry duplicates "Organization JSON-LD schema to homepage", which already appears earlier in this same Added list (with the (#131) reference). Remove this redundant line to avoid a duplicate changelog entry.
🧠 Review effort: Balanced
Give feedback about Copilot approvals in this survey to enter a drawing for a $150 gift card.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves #253
Summary
This PR addresses all items in issue #253:
Changes
1. Fix broken links (/main/ → /master/)
mainbranch instead ofmaster2. Update CHANGELOG.md with missing releases
3. Automate future changelog updates
.github/workflows/update-changelog.ymlTesting
The workflow will be tested when the next draft release is published. It will:
Why a PR instead of auto-commit?
Master branch is protected, so the workflow creates a PR instead of auto-committing. This: