← Back to issue list

docs: fix version string for 1.x

View original Github issue

Metadata

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

Current evaluation

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.

Resolution: closed resolved

Reason: PR #1335 was merged after approval and all CI checks passed. The author confirmed it targets a hotfix branch, applying the RTD version-slug fix alongside merged PR #1334.

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/rockcraft/blob/main/CONTRIBUTING.md). - [X] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [X] 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 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.
stealth/space-bunny-alpha — closed resolved Merged PR #1335 (jahn-junior) backported the docs version-string fix from PR #1334 to the 1.x hotfix branch; reviewer mr-cal pointed out the branch targeting and it was merged after confirmation.
stealth/space-bunny-alpha — closed resolved Merged canonical/rockcraft#1334 to correct the 1.x docs version string after RTD slug simplification: builds show major/minor, while latest shows dev.
qwen/qwen3.6-35b-a3b — — Merged to a hotfix branch, fixing 1.x documentation version strings to show major.minor locally and in branches, with latest showing dev. Approved by three reviewers and passed all CI checks after clarifying its scope relative to PR 1334.
qwen/qwen3.6-35b-a3b
Staleness: 0
Complexity: 5
Confidence: 95
needs review Fixes documentation version string display for 1.x builds by adjusting RTD slug handling. Approved by two reviewers, targets a hotfix branch, and has no unresolved comments.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 90
needs review Updates documentation build configuration to correctly display major/minor version strings in titles, targeting a hotfix branch. Approved by two reviewers, zero unresolved comments, and ready for merge.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 90
needs review Fixes documentation version string display for 1.x releases and the latest branch. Approved by one reviewer, author clarified it targets a hotfix branch. Currently awaiting final maintainer review and merge.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 85
needs review Fixes documentation version string display for 1.x builds by adjusting RTD slug handling. Currently approved by one reviewer but has one unresolved comment questioning the target branch and overlap with another PR.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 85
needs review Documentation fix updating version string display in docs title. Approved by one reviewer but has one unresolved comment asking about target branch and relation to PR #1334.
qwen/qwen3.6-35b-a3b
Staleness: 0
Complexity: 0
Confidence: 95
needs review Updates documentation build configuration to correctly display major/minor version strings in titles for local, PR, and branch builds, except the latest branch which shows 'dev'. Currently awaiting review.
qwen/qwen3.6-35b-a3b
Staleness: 0
Complexity: 5
Confidence: 85
needs review Updates documentation version string display to show major/minor versions for builds, while latest shows dev. Currently pending initial maintainer review with no CI checks run.

Update history

Date Change
updated
updated
updated
updated
updated
created

Related work

  • Related To: canonical/rockcraft#1334 (confidence 99%)

    Main-branch counterpart merged as commit b2bc69ce; #1335 applies the fix to the 1.x hotfix branch.

Related issues

Issue Project State Summary Similarity
#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.
86%
#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.
83%
#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.
82%
#2830 docs: fix version string for 'latest' charmcraft merged 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).
80%
#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.
78%
#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%
#2787 docs: fix versioning logic charmcraft merged Merged PR canonical/charmcraft#2787 by maintainer jahn-junior fixes the version name used for branch-based docs builds (1 file, +1/-2); approved by 1 reviewer, all CI checks passed.
75%
#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.
75%
#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.
74%
#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.
72%