docs: fix incorrect version in documentation
Metadata
Current evaluation
Merged in #586 via commits 0ffc2395 and d5da1878, fixing #584 by fetching tags for Read the Docs and labeling unreleased docs as dev.
Resolution: closed resolved
Reason: PR #586 was merged with commit 0ffc2395 to fetch tags in Read the Docs builds and d5da1878 to show dev for non-release builds. These changes directly resolved the versioning problem tracked by #584.
Evaluated by: mr-cal-bot
No scores available.
Issue body
This PR contains two commits:
* build(docs): fetch tags in readthedocs builds
Readthedocs builds don't fetch tags when cloning the repo. This is a problem
for us because Rockcraft's version comes from the tag (via setuptools-scm),
so do a fetch of the tags as a post-checkout step.
* docs: use "dev" for non-release builds
The bug is this: If a build is done off of (say) 'main', the version coming
from 'git describe' will be something like 1.32.2.postXXXX. We previously
dropped the ".post*" suffix because it confused the spellchecker but that
just leaves the misleading "1.32.2" string. It's misleading because that's
an actual released version that does *not* contain a lot of the content
in 'main'.
So just use "dev" instead, to make it extra explicit that the docs refer
to an unreleased version of the software.
Fixes #584
--------
For reference, this is the setting in RDT's configuration page that makes "stable" be the default version:
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged in #586 via commits 0ffc2395 and d5da1878, fixing #584 by fetching tags for Read the Docs and labeling unreleased docs as dev. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/rockcraft#586, fixing #584 by fetching tags in ReadTheDocs builds and labeling unreleased documentation versions "dev". | |
| qwen/qwen3.6-35b-a3b | — | — | Merged to resolve #584. Configured ReadTheDocs to fetch tags and updated non-release documentation to display dev instead of misleading release strings. Approved by two reviewers with passing CI. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged changes to fetch git tags in ReadTheDocs builds and display dev for non-release documentation, resolving misleading version strings. Resolves #584. |
Update history
No update history recorded yet.
Related work
-
Likely Fixed By:
canonical/rockcraft#584
(confidence 100%)
Incorrect Read the Docs version reported in #584 was fixed by merged PR #586.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #6295 docs: fix version numbering | snapcraft | merged | Merged #6295 (commit 8456b4421), fixing docs version numbering to use Read the Docs branch metadata and keep local and RTD builds consistent. | |
| #6387 docs: fix version on 'latest' | snapcraft | merged | Merged PR #6387 via commit a67bdcd1f, fixing docs titles to show major.minor for local, PR, and branch builds while displaying dev for latest. | |
| #2831 docs: fix version string for 3.x | charmcraft | merged | Merged #2831 to display the 3.x major/minor version in docs titles; the latest branch remains labeled dev after Read the Docs slug simplification. | |
| #588 docs: fix version in title | starbase | merged | Merged docs fix (commit 23328cd): docs page titles now display major.minor version for local, PR and branch builds; only the 'latest' branch shows 'dev', following the RTD version slug simplification. | |
| #1334 docs: fix version string on latest | rockcraft | merged | Merged PR #1334 fixed docs version strings: local, PR, and branch builds show major.minor, while latest shows dev. Commit: b2bc69ce. | |
| #6313 docs: fix version numbering | snapcraft | merged | Merged docs PR applying the #6295 patch, fixing docs version numbering in docs/conf.py via Read the Docs branch/version-type metadata; patch landed as commit 8456b4421. | |
| #399 docs: fix title markup | craft-parts | merged | Merged #399 as commit 8b705ede, correcting a one-line documentation title markup issue after two approvals. | |
| #1189 docs: format doc version as major.minor | rockcraft | merged | Merged into main as fc0e073a, replacing #1185; documentation now renders release versions as major.minor and labels latest RTD builds as dev. | |
| #4864 build(docs): fix version in rtd builds | snapcraft | merged | PR #4864 merged as commit 3d05bf373: adds a post_checkout `git fetch --tags --unshallow` step to .readthedocs.yaml and installs snapcraft explicitly so docs show the correct version on RTD builds. | |
| #2734 docs: improve versioning logic | charmcraft | merged | Merged as 5fb6af27, updating docs versioning so the unversioned/latest documentation is labeled “Charmcraft dev documentation.” |