← Back to issue list

Wrong Rockcraft version in readthedocs docs

View original Github issue

Metadata

Project
rockcraft
Number
#584
Type
issue
State
closed
Author
tigarmo
Labels
—
Created
Updated
Closed

Current evaluation

Fixed by merged PR #586: Read the Docs now fetches tags and labels unreleased documentation as dev instead of showing an outdated patch version.

Resolution: closed resolved

Reason: Merged PR canonical/rockcraft#586 fixed #584 by fetching tags during Read the Docs builds and displaying dev for unreleased documentation.

Evaluated by: mr-cal-bot

No scores available.

Issue body

### Bug Description The Rockcraft version listed on the left-hand side of the [readthedocs docs](https://documentation.ubuntu.com/rockcraft/en/latest/) is wrong. It currently says "1.3.2" but it's actually "1.3.2.+gitwhatever". I'm pretty sure this happened when I [trimmed that string](https://github.com/canonical/rockcraft/blob/main/docs/conf.py#L38) to get around a spellchecking issue (spellchecked was trying to check the version string). This is bad because it's misleading: there are currently features listed in the docs that will be in 1.4.0 but aren't in 1.3.2. ### To Reproduce . ### Environment . ### rockcraft.yaml ```shell . ``` ### Relevant log output ```shell . ```

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Fixed by merged PR #586: Read the Docs now fetches tags and labels unreleased documentation as dev instead of showing an outdated patch version.
stealth/space-bunny-alpha — closed resolved Fixed by merged PR #586 (commit d5da1878): Read the Docs now fetches tags and labels unreleased documentation as dev instead of falsely showing 1.3.2.
stealth/space-bunny-alpha — closed resolved Fixed by merged PR #586, which fetched tags for ReadTheDocs builds and labeled unreleased documentation as “dev.”
stealth/space-bunny-alpha — closed stale Closed without a public fix. The reported incorrect Read the Docs version had no documented resolution; a later version-display change was merged in #1334 (b2bc69ce).
stealth/space-bunny-alpha — closed resolved Closed after the docs version logic was corrected to label the latest build as “dev”; no linked public PR or fixing commit was recorded.
qwen/qwen3.6-35b-a3b — — Closed without a public fix. The report noted an incorrect ReadTheDocs version string caused by trimming the version in docs/conf.py. An internal Jira ticket was created, but no resolution or merge was documented.
qwen/qwen3.6-35b-a3b — — Closed without a fix or merge. The ReadTheDocs version string discrepancy remains unresolved, with tracking transferred to internal Jira ticket CRAFT-3018.
qwen/qwen3.6-35b-a3b — — Closed without a public resolution. Tracked internally as Jira ticket CRAFT-3018. The documentation version string mismatch remains unresolved.
qwen3.6-35b-a3b-mtp-q6 — — Closed without a documented fix or merge. The incorrect ReadTheDocs version string in docs/conf.py was left unresolved, likely abandoned or handled internally.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/rockcraft#586 (confidence 100%)

    Merged documentation fix explicitly resolves the incorrect version shown by Read the Docs.

Related issues

Issue Project State Summary Similarity
#1187 docs: release notes for 1.18 rockcraft merged Merged PR #1187 in commit 0bd07273, adding Rockcraft 1.18 release notes across three documentation files.
72%
#627 Insufficient documentation on how to build Rockcraft's documentation rockcraft open Rockcraft now documents fresh-environment documentation setup, builds, linting and PR submission, and tests the guide; the obsolete docs/installdocs workflow has been replaced.
72%
#1204 docs: release notes for 1.19.0 rockcraft merged Merged PR #1204 added Rockcraft 1.19.0 release notes across three documentation files in commit 77be1bab.
70%
#634 feat: use versioned form of doc urls rockcraft merged Merged PR #634 updated Rockcraft error messages and init templates to use versioned documentation URLs, including the running version in links.
70%
#1302 docs: release notes for 1.20 rockcraft merged Docs-only PR #1302 by maintainer tigarmo merged into rockcraft main as commit 289c48bc, adding 119 lines across two files: Rockcraft 1.20 release notes plus the index entry. Approved by 2 reviewers.
70%