← 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 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.

Suggested action:

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
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 documentation pull request that backfills changelog release links and adds a template. Approved by three reviewers, passed all CI checks, and modified one file with 28 additions and one deletion.
81%
#328 docs: make minor improvements to release note template starbase merged Merged minor release note template updates. Changes clarify present tense usage with "now" and require hyperlinked fixed issues. Approved by three reviewers with passing CI checks.
76%
#2248 docs: update to the latest release notes template charmcraft merged Merged documentation update to the latest release notes template. Changes include auto-formatting across seven files, approved by two reviewers, and passed most continuous integration checks.
74%
#286 docs: add release notes index and template starbase merged Merged documentation update adding a release notes index to the TOC and a template. Approved by three reviewers, passed CI, and modified six files. Reviewers confirmed the forward-porting section remains optional.
74%
#5386 docs: link from changelog to release notes snapcraft merged 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.
73%
#876 docs(changelog): release 2.1.3 craft-parts closed Merged to update the changelog for release 2.1.3. Approved by two reviewers.
73%
#376 docs: update changelog fetch-service merged Merged changelog update documenting recent features, bug fixes, and dependency upgrades. Approved by two reviewers and passed CI checks.
72%
#905 docs(changelog): release 2.1.3 craft-parts merged Merged release 2.1.3 changelog update. Cherry-picked documentation fixes from #872 and resolved linter failures. Approved by two reviewers with passing CI checks.
72%
#258 docs: update readme and template, fix build error starbase merged Merged after two reviewer approvals and passing CI. Updated README wording, added doc preparation details, and disabled PDF and EPUB generation to resolve build errors. All changes passed tests with 100% coverage.
72%
#909 docs: fix linting for release tags and backfill changelog links to 2.0.0 craft-parts merged Merged documentation update fixing linting for release tags and backfilling changelog links to version 2.0.0. Resolves #908 and CRAFT-3715. Approved by two reviewers, passed CI, and modified two files with seventeen added lines.
71%