← Back to issue list

fix: trim documentation urls to major number

View original Github issue

Metadata

Project
craft-application
Number
#1140
Type
pull request
State
merged
Author
medubelko
Labels
—
Created
Updated
Closed

Current evaluation

Merged as 209a1367: documentation URLs now default to major-version paths, with an opt-out, fixing canonical/snapcraft#6300.

Resolution: closed resolved

Reason: PR canonical/craft-application#1140 was merged in commit 209a1367 after approval. It trims versions such as 1.3.7 to 1 by default while allowing full-version documentation paths.

Evaluated by: mr-cal-bot

No scores available.

Issue body

When a documentation URL such as ubuntu.com/docs/project/{version} is passed, with app version `1.3.7`, trim to the major number only by default. This accords with the updated documentation version policy. This would be the default behaviour. Apps still using the full version number can opt not to trim. Fixes canonical/snapcraft/issues/6300. --- - [x] Have you followed the guidelines for contributing? - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [x] Have you successfully run `make lint && make test`? - [x] Have you added an entry to the changelog (`docs/reference/changelog.rst`)?

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged as 209a1367: documentation URLs now default to major-version paths, with an opt-out, fixing canonical/snapcraft#6300.
stealth/space-bunny-alpha — closed resolved Merged canonical/craft-application#1140 as 209a1367, defaulting documentation URLs to major-version paths with an opt-out; fixed canonical/snapcraft#6300.
stealth/space-bunny-alpha — closed resolved Merged craft-application PR #1140: documentation URLs now default to major versions, fixing snapcraft#6300.
qwen/qwen3.6-35b-a3b — — Merged. Documentation URLs are now trimmed to the major version number by default, aligning with the updated documentation version policy. Applications can opt out. Resolves issue #6300. Approved by two reviewers and merged.
qwen/qwen3.6-35b-a3b — — Merged changes trim documentation URLs to the major version number by default, aligning with the updated documentation version policy. Applications can opt out. Resolves issue #6300 after passing CI and receiving two approvals.
qwen/qwen3.6-35b-a3b
Staleness: 10
Complexity: 15
Confidence: 85
needs review Trims documentation URLs to the major version number by default to align with updated policy. Currently approved by two reviewers but has one unresolved comment and several failing CI checks.
qwen3.6-35b-a3b-mtp-q6
Staleness: 5
Complexity: 15
Confidence: 85
needs review Trims documentation URLs to the major version number by default to align with updated documentation policies. Allows opting out for full version numbers. Fixes issue #6300. Currently unreviewed with no comments or CI status indicated.

Update history

Date Change
updated
updated
updated
updated
updated
updated
updated
updated
created

Related work

  • Related To: canonical/snapcraft#6300 (confidence 100%)

    The broken Snapcraft documentation URL was fixed by this merged change.

Related issues

Issue Project State Summary Similarity
#6389 docs: fix version in Snapcraft 9 snapcraft merged Merged PR #6389 (commit 7b092076d) fixed Snapcraft 9 docs versioning: builds show major.minor, while latest shows dev.
71%
#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.
71%
#2327 docs: fix some links charmcraft merged Merged PR #2327 (f829b25d), correcting broken documentation links in two files with a +3/-3 change.
70%
#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.
70%