← Back to issue list

docs: fix version string for 'latest'

View original Github issue

Metadata

Project
charmcraft
Number
#2830
Type
pull request
State
merged
Author
jahn-junior
Labels
—
Created
Updated
Closed

Current evaluation

Docs-only PR merged: RTD page titles now show major.minor for local/PR/branch builds, with 'latest' branch showing 'dev', following simplification of RTD version slugs (+2/-6 in one file).

Resolution: closed resolved

Reason: PR #2830 by maintainer jahn-junior was merged into main with all CI checks passing (lint, fast/slow test suites, CLA, schema validation) and no failing jobs. It updates the documentation version string logic so only the 'latest' branch build renders 'dev'.

Evaluated by: mr-cal-bot

No scores available.

Issue body

With this change, all local, PR, and branch builds will show the major and minor version in the docs title. The only exception is the 'latest' branch build, which will show 'dev' as the version. This was brought about by the simplification of our RTD version slugs. --- - [X] I've followed the [contribution guidelines](https://github.com/canonical/charmcraft/blob/main/CONTRIBUTING.md). - [X] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [ ] I've successfully run `make lint && make test`. - [ ] I've added or updated any relevant documentation. - [ ] In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing. - [ ] I've updated the relevant release notes.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Docs-only PR merged: RTD page titles now show major.minor for local/PR/branch builds, with 'latest' branch showing 'dev', following simplification of RTD version slugs (+2/-6 in one file).
stealth/space-bunny-alpha — closed resolved Merged docs change: RTD titles now show major.minor for local, PR, and branch builds; the 'latest' branch shows 'dev'.
qwen/qwen3.6-35b-a3b — — 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.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 90
needs review Updates documentation version string display to show major/minor versions, except for the 'latest' branch which shows 'dev'. Currently pending maintainer review with all CI checks passing.

Update history

Date Change
updated
created

Related issues

Issue Project State Summary Similarity
#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.
92%
#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.
89%
#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.
88%
#1335 docs: fix version string for 1.x rockcraft merged Merged into the 1.x hotfix branch so docs show major.minor for local, PR, and branch builds, and dev for latest; this parallels #1334 on main.
80%
#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.
79%
#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.
79%
#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.
78%
#6390 docs: fix version in Snapcraft 8 snapcraft merged Merged #6390 corrected Snapcraft 8 RTD title versioning: local, PR, and branch builds show major.minor, while the latest branch shows dev.
77%
#2832 docs: fix version string for 4.x charmcraft merged Merged #2832 corrected docs title versioning for Charmcraft 4.x: local, PR, and branch builds show major/minor; the latest branch shows dev.
76%
#2649 docs: format doc version as major.minor charmcraft merged Merged in PR #2649 (commit fa566418): docs/conf.py now derives the Sphinx release string as major.minor from charmcraft.__version__ instead of using the full patch version, with a 'dev' value for latest RTD builds.
74%