← Back to issue list

docs(changelog): add template and refs to all releases

View original Github issue

Metadata

Project
craft-parts
Number
#1112
Type
pull request
State
merged
Author
mr-cal
Labels
PR: Rebase
Created
Updated
Closed

Current evaluation

Merged #1112 (commits 1bbdaf6c, 61ff44af): added stable release-note reference tags and a reusable changelog template so generated links no longer shift.

Resolution: closed resolved

Reason: PR #1112 was approved and merged with all CI checks passing. Commits 1bbdaf6c and 61ff44af added stable tags to existing releases and introduced a template for future release notes.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [ ] Have you added an entry to the changelog (`docs/reference/changelog.rst`)? ----- Adds reference tags to each release note. Previously, links to releases would have reference tags like `#id1`, `#id2`, and so on. This was bad because the tags would point to a different release each time a new release was added. This also adds a template to make future releases more consistent.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged #1112 (commits 1bbdaf6c, 61ff44af): added stable release-note reference tags and a reusable changelog template so generated links no longer shift.
stealth/space-bunny-alpha — closed resolved Merged PR #1112 added stable reference tags to all release notes and a changelog template to keep future release entries consistent.
stealth/space-bunny-alpha — closed resolved Merged PR #1112 updated all release-note links to stable reference tags and added a changelog template to keep future releases consistent and prevent links from shifting.
qwen/qwen3.6-35b-a3b — — Merged changelog improvements that replace dynamic reference tags with stable identifiers to prevent broken links. Adds a standardized template for consistent future releases. Approved by two reviewers and passed all CI checks.
qwen3.6-35b-a3b-mtp-q6 — — Merged changes adding stable reference tags to release notes, fixing broken links when new releases are added. Also introduces a changelog template to standardize future documentation.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#930 docs(changelog): backfill release links and add a template craft-application merged Merged #930 via commit 17b5f495, adding GitHub release links for historical changelog entries and a reusable release template.
80%
#328 docs: make minor improvements to release note template starbase merged Merged in #328 via commit fbd7c43: clarified that present-tense “now” is acceptable in release notes, added examples, and made fixed-issue entries explicitly links.
74%
#286 docs: add release notes index and template starbase merged Merged into main as commit dfe2e9a ("docs: add release notes index and template (#286)"), adding docs/release-notes/index.rst with a release notes TOC section and inline release-note template.
73%
#5386 docs: link from changelog to release notes snapcraft merged Merged PR #5386 (commit 3fa3a6a3a) added a notice that the changelog was superseded by, and links to, the release notes.
71%