docs: fix incorrect version in documentation
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Updated ReadTheDocs to fetch git tags for accurate version detection and changed non-release documentation builds to display dev instead of misleading release version numbers. Resolves #584. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #588 docs: fix version in title | starbase | merged | Merged documentation update correcting version display in titles. Builds now show major and minor versions, with latest displaying dev. Approved by two reviewers and passed all CI checks. | |
| #6295 docs: fix version numbering | snapcraft | merged | Merged documentation fix aligning ReadTheDocs version numbering with the new branch-based release policy. Incorporated reviewer feedback to refactor conditional logic and add comments. Updated version detection for main, hotfix, and PR branches. | |
| #219 docs: fix readthedocs documentation generation | craft-parts | merged | Merged. Resolved ReadTheDocs build failures by installing missing environment packages, adding the changelog to the documentation index, and removing python-apt from setup to prevent version conflicts. Approved and passed CI. | |
| #2830 docs: fix version string for 'latest' | charmcraft | merged | Merged documentation fix correcting the version string for the 'latest' branch build. Updates ReadTheDocs slug handling to display major/minor versions for local and branch builds, while 'latest' shows 'dev'. All CI checks passed. | |
| #2787 docs: fix versioning logic | charmcraft | merged | Merged. Fixes branch-based documentation build versioning logic by correcting version name generation. Passed all CI checks and received reviewer approval. | |
| #2832 docs: fix version string for 4.x | charmcraft | merged | Merged. Updated documentation to correctly display major and minor version strings for local, PR, and branch builds, reserving 'dev' for the latest branch. Approved by one reviewer with all CI checks passing. | |
| #5957 docs: fix typo in ROS version names | snapcraft | merged | Merged a documentation update correcting a typo in ROS version names. Approved by two reviewers, modified one file, and passed all CI checks. A reviewer confirmed ReadTheDocs was misreporting the build status. | |
| #6313 docs: fix version numbering | snapcraft | merged | Merged documentation update fixing version numbering by applying patch from #6295. Approved by reviewer, passed CI checks, and successfully merged with 7 lines changed across one file. | |
| #2831 docs: fix version string for 3.x | charmcraft | merged | Merged docs fix for 3.x version string. Local, PR, and branch builds now show major and minor version in the title, while latest shows 'dev'. Aligns with simplified Read the Docs slugs. Approved and merged. | |
| #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. |