← Back to issue list

docs: link from changelog to release notes

View original Github issue

Metadata

Project
snapcraft
Number
#5386
Type
pull request
State
merged
Author
mr-cal
Labels
—
Created
Updated
Closed

Current evaluation

Merged PR #5386 (commit 3fa3a6a3a) added a notice that the changelog was superseded by, and links to, the release notes.

Resolution: closed resolved

Reason: PR #5386 merged into main as commit 3fa3a6a3a, completing the documentation change after approval and review.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [x] Have you followed the [guidelines for contributing](https://github.com/canonical/snapcraft/blob/main/CONTRIBUTING.md)? - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [x] Have you successfully run `make lint`? - [x] Have you successfully run `make test`? --- Adds a notice that the changelog has been superseded by the release notes, based on feedback from @simondeziel.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged PR #5386 (commit 3fa3a6a3a) added a notice that the changelog was superseded by, and links to, the release notes.
stealth/space-bunny-alpha — closed resolved Merged canonical/snapcraft#5386 (3fa3a6a3a), adding a changelog notice directing readers to the release notes.
qwen/qwen3.6-35b-a3b — — Merged a documentation update adding a notice in the changelog linking to the release notes, per @simondeziel's feedback. Approved by two reviewers and passed CI. The changelog is now superseded by the release notes.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation update adding a notice linking from the changelog to the release notes, reflecting the changelog's supersession. Changes passed linting and testing prior to integration.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#608 docs: update changelog fetch-service merged Merged PR #608 updated the release changelog via commit 4078df1.
75%
#588 docs: update changelog fetch-service merged Merged PR #588 added five changelog lines in commit c8237ec.
74%
#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.
73%
#5355 docs: migrate release content snapcraft merged Merged #5355 via commit d8b1da174, moving changelog content into the release-notes directory.
72%
#6229 docs: fix old link in changelog snapcraft merged Merged docs-only PR #6229 (commit c9b746fbd) by maintainer bepri, updating a stale changelog link whose target page's heading anchor had changed; 1-line change, approved by 2 reviewers.
72%
#1039 docs: update changelog craft-parts merged Merged PR #1039 as commit 3c98cfe2, updating the changelog with 4 added and 1 removed line across two files.
72%
#820 docs: finalize changelog for 3.1.0 craft-providers merged Merged PR #820 as cb816db, finalizing the 3.1.0 changelog with the release date, feature and bug-fix notes, and a link to the complete release history.
72%
#440 docs: update changelog fetch-service merged Merged the 13-line changelog-only update in PR #440 via commit 44f56ee after two approvals.
72%
#1112 docs(changelog): add template and refs to all releases craft-parts merged Merged #1112 (commits 1bbdaf6c, 61ff44af): added stable release-note reference tags and a reusable changelog template so generated links no longer shift.
71%
#1841 docs: add and partially backfill a changelog charmcraft merged Merged PR #1841 (commit 3f0dbc6c) by lengau added docs/reference/changelog.rst with a release template and partial backfill, closing issue #1814. Later commits continued the backfill and moved newer releases to separate release-notes pages.
71%