← Back to issue list

Add changelog to sphinx docs

View original Github issue

Metadata

Project
charmcraft
Number
#1814
Type
issue
State
closed
Author
lengau
Labels
—
Created
Updated
Closed

Current evaluation

Added docs/reference/changelog.rst and backfilled prior releases via merged PR #1841 (commit 3f0dbc6c), closing the request for a Sphinx changelog.

Resolution: closed resolved

Reason: PR #1841 ("docs: add and partially backfill a changelog", commit 3f0dbc6c) created docs/reference/changelog.rst, registered it in docs/reference/index.rst, and backfilled earlier releases; later commits such as 01fa6edb (#1861) and 5037fcb1 (#2038) continued maintaining it.

Evaluated by: mr-cal-bot

No scores available.

Issue body

### What needs to get done Add a changelog to the sphinx logs and backfill it ### Why it needs to get done There's currently no changelog.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Added docs/reference/changelog.rst and backfilled prior releases via merged PR #1841 (commit 3f0dbc6c), closing the request for a Sphinx changelog.
stealth/space-bunny-alpha — closed resolved Added and partially backfilled the Sphinx changelog in merged PR #1841 (commit 3f0dbc6c), resolving the request.
qwen3.6-35b-a3b-mtp-q6 — — Closed without resolution. The request to add and backfill a Sphinx changelog was synced to Jira (CRAFT-3241) but appears abandoned, with no implementation or merge recorded.
qwen/qwen3.6-35b-a3b — — Closed without implementation. The request to add a changelog to Sphinx documentation was deferred, with tracking moved to an internal Jira ticket. No code changes or merges were made.
qwen/qwen3.6-35b-a3b — — Requesting a changelog for Sphinx documentation was closed without implementation. No pull requests or code changes were submitted, indicating the task was abandoned.
qwen3.6-35b-a3b-mtp-q6 — — Closed without implementation. No changelog was added to Sphinx documentation, and no resolution or merge details were provided. The request appears abandoned or deferred.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/charmcraft#1841 (confidence 95%)

    Merged PR titled 'docs: add and partially backfill a changelog' (commit 3f0dbc6c), which created docs/reference/changelog.rst.

  • Related To: canonical/charmcraft#1861 (confidence 70%)

    Follow-up 'docs(changelog): add 3.2.0 release' (commit 01fa6edb) extending the new changelog.

Related issues

Issue Project State Summary Similarity
#179 docs: add changelog to Sphinx docs fetch-service merged Merged PR #179 added the changelog to the Sphinx documentation in commit ebd0909.
84%
#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.
75%
#5070 docs: improve sidebar for the changelog page snapcraft merged Merged docs PR: added `:tocdepth: 2` to docs/release-notes/changelog.rst so Sphinx renders a per-release table of contents in the sidebar, making long changelog sections easier to navigate.
74%