← Back to issue list

Broken docs URL for remote build explanation

View original Github issue

Metadata

Project
snapcraft
Number
#6300
Type
issue
State
closed
Author
steinbro
Labels
Status: Triaged Type: Documentation
Created
Updated
Closed

Current evaluation

Remote-build doc links now use the major version (9.0 instead of 9.0.0), fixed by craft-application PR #1140 in commit 209a1367.

Resolution: closed resolved

Reason: Craft Application PR #1140 changed render_doc_url() to trim documentation versions to the major version and was merged as commit 209a1367.

Evaluated by: mr-cal-bot

No scores available.

Issue body

### Check existing issues - [x] I've verified that this bug isn't described by any existing issues. ### Bug description When a remote build fails, the output includes the text: ``` For more information, check out: https://documentation.ubuntu.com/snapcraft/9.0.0/explanation/remote-build ```` The URL is broken, but can be fixed by changing the version number from `9.0.0` to `9.0`. The fix may be to correct where the documentation is being published, rather than changing the URL in the error message Perhaps a separate bug, but the 404 page also fails to load stylesheets and consequently is rendered unstyled. ### Steps to reproduce See bug description ### Environment Snapcraft 9.0 from latest/stable on Ubuntu 26.04 ### snapcraft.yaml ```yaml ``` ### Log output ```shell ```

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Remote-build doc links now use the major version (9.0 instead of 9.0.0), fixed by craft-application PR #1140 in commit 209a1367.
stealth/space-bunny-alpha — closed resolved Fixed by trimming documentation URLs to major versions in Craft Application PR #1140, commit 209a1367, changing /snapcraft/9.0.0/ to /snapcraft/9.0/.
stealth/space-bunny-alpha — closed resolved Remote-build documentation links were fixed by trimming URLs to the major version in craft-application PR #1140, merged as commit 209a1367: /snapcraft/9.0.0/ becomes /snapcraft/9.0/.
qwen3.6-35b-a3b-mtp-q6 — — Fixed by agreeing to trim the semantic version in craft-application's render_doc_url() to correct the broken remote build documentation URL. The unrelated 404 styling issue was noted as separate.
qwen/qwen3.6-35b-a3b
Staleness: 20
Complexity: 25
Confidence: 90
Support Request: 0
keep open Broken documentation URL in remote build error output caused by setuptools version formatting. Maintainers have identified the root cause in craft-application and agreed on a fix approach.
qwen3.6-35b-a3b-mtp-q6
Staleness: 10
Complexity: 15
Confidence: 90
Support Request: 0
keep open Broken documentation URL generated by render_doc_url() due to setuptools_scm including the patch version. Maintainers have identified the root cause and agreed on a fix to trim the version string.

Update history

Date Change
closed

Related work

Related issues

Issue Project State Summary Similarity
#6311 fix(docs): update base docs_url to use stable snapcraft closed Closed unmerged as a duplicate: canonical/craft-application#1140 fixed #6300 in commit 209a1367 by routing remote-build documentation through the major version.
74%
#4882 docs: add explanation for remote build snapcraft merged PR #4882 (mr-cal) merged as commit bd49f8db0, adding docs/explanation/remote-build.rst plus index entries to explain current and legacy remote builders; closes documentation issue #4842 (CRAFT-3000).
73%