← Back to issue list

docs: fix version string for 3.x

View original Github issue

Metadata

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

Current evaluation

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.

Suggested action:

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
qwen/qwen3.6-35b-a3b 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.
qwen/qwen3.6-35b-a3b
Staleness: 0
Complexity: 5
Confidence: 85
needs review Updates documentation version string display for 3.x builds to align with simplified RTD slugs. Currently approved by one reviewer but has one unresolved comment and several failing CI checks on slow tests and lint.

Update history

Date Change
updated
created

Related issues

Issue Project State Summary Similarity
#6387 docs: fix version on 'latest' snapcraft merged Merged PR updates Read the Docs slug handling to fix version display on the 'latest' branch. Local, PR, and branch builds now show major/minor versions, while 'latest' displays 'dev'. Approved by reviewers and passed all CI checks.
84%
#1334 docs: fix version string on latest rockcraft merged Merged documentation fix updating version string display. Local, PR, and branch builds now show major and minor versions, while the latest branch displays dev. Aligns with simplified RTD version slugs.
84%
#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.
83%
#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.
82%
#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.
80%
#1335 docs: fix version string for 1.x rockcraft merged 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.
78%
#586 docs: fix incorrect version in documentation rockcraft merged 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.
77%
#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.
76%
#6173 docs: format doc version as major.minor snapcraft merged Merged a documentation update that formats version strings as major.minor. Approved by two reviewers, passed CI checks, and integrated with a three-line change.
74%
#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.
74%