docs: add release notes index and template
Metadata
Current evaluation
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.
Suggested action: —
No scores available.
Issue body
Release notes occupy their own top-level section in the documentation TOC.
The template for individual release notes is included as a comment at the end of the index. This follows a pattern set by our changelogs. If there's a better way of including copyable templates, please chime in!
- [x] Have you followed the guidelines for contributing?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `tox`?
-----
CRAFT-3712
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update adding a release notes index and template. Reviewers approved keeping the forward-porting section optional. Changes follow existing changelog patterns and address CRAFT-3712. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #19 docs: update toc and incorrect labels | craft-store | merged | Merged documentation update correcting the table of contents and fixing incorrect labels across two files. Approved by a reviewer and passing CI, the +4/-1 line changes were integrated into the main branch. | |
| #826 docs: update CONTRIBUTING.md | craft-application | merged | Merged documentation update aligning CONTRIBUTING.md with the official template. Approved by three reviewers with all CI checks passing. The change modifies one file with 104 additions and 48 deletions. | |
| #289 docs: release notes for 2.8.0 | craft-cli | merged | Merged documentation update adding release notes for version 2.8.0. Approved by two reviewers and integrated into the main branch with a seven-line addition. | |
| #375 docs: add patch fixes to release notes template | starbase | merged | Merged changes adding patch fixes section to release notes template. Approved by three reviewers with passing CI checks. Headings apply only to releases with fixes, using separate entries for subsequent patches while leaving older releases unchanged. | |
| #5883 docs: add release notes entry for 8.13.2 | snapcraft | merged | Merged documentation update adding release notes for version 8.13.2. Approved by two reviewers and merged despite initial CI failures in integration tests and publishing pipelines. Added seven lines to one file. | |
| #1204 docs: release notes for 1.19.0 | rockcraft | merged | Merged documentation update for version 1.19.0 release notes. Approved by four reviewers and passed CI checks. Changes span three files with 101 additions. |