← Back to issue list

docs: replace some snapcraft.io links and fix confinement key docstring

View original Github issue

Metadata

Project
snapcraft
Number
#5510
Type
pull request
State
merged
Author
astrojuanlu
Labels
—
Created
Updated
Closed

Current evaluation

Merged PR #5510 as commit 631682a34, correcting the confinement docstring and replacing outdated or broken Snapcraft, scriptlet, and craftctl documentation links.

Resolution: closed resolved

Reason: PR #5510 was merged into main as commit 631682a34, delivering the documentation corrections and link updates.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [x] Have you followed the [guidelines for contributing](https://github.com/canonical/snapcraft/blob/main/CONTRIBUTING.md)? - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [x] Have you successfully run `make lint`? - [ ] Have you successfully run `make test`? --- - Fixed a small typo in the reference documentation of `snapcraft.yaml`, specifically the `confinement` property. - Used a more appropriate reference instead of relying on a RTD redirection. - Fix various references to scriptlets or `craftctl` that were dangling or broken. <details> <summary>I could not run `make test` successfully, it was failing for me on the `main` branch.</summary> ``` ❯ uv sync --group dev --group docs --group dev-noble --group lint Resolved 212 packages in 1ms Audited 194 packages in 0.45ms ❯ make test VERSION_CODENAME=noble Makefile:31: warning: overriding recipe for target 'lint-docs' common.mk:177: warning: ignoring old recipe for target 'lint-docs' uv run pytest ... collected 6213 items / 1 error ========= ERRORS ========= ___________ ERROR collecting tests/legacy/unit/repo/test_deb.py ___________ tests/legacy/unit/repo/test_deb.py:63: in <module> class TestPackages(unit.TestCase): tests/legacy/unit/repo/test_deb.py:259: in TestPackages @mock.patch.object(repo._deb.Ubuntu, "normalize") E AttributeError: module 'snapcraft_legacy.internal.repo' has no attribute '_deb' ... ❯ uv tree Resolved 212 packages in 3ms snapcraft ├── attrs v25.3.0 ├── catkin-pkg v1.0.0 │ ├── docutils v0.21.2 │ ├── pyparsing v3.2.3 │ ├── python-dateutil v2.9.0.post0 │ │ └── six v1.17.0 │ └── setuptools v80.0.0 ├── click v8.1.8 ├── craft-application[remote] v5.2.0 │ ├── annotated-types v0.7.0 │ ├── craft-archives v2.1.0 │ │ ├── distro v1.9.0 │ │ ├── launchpadlib v2.1.0 │ │ │ ├── httplib2 v0.22.0 │ │ │ │ └── pyparsing v3.2.3 │ │ │ ├── lazr-restfulclient v0.14.6 │ │ │ │ ├── distro v1.9.0 │ │ │ │ ├── httplib2 v0.22.0 (*) │ │ │ │ ├── oauthlib v3.2.2 │ │ │ │ ├── setuptools v80.0.0 │ │ │ │ ├── six v1.17.0 │ │ │ │ └── wadllib v2.0.0 │ │ │ │ └── lazr-uri v1.0.7 │ │ │ │ └── setuptools v80.0.0 │ │ │ └── lazr-uri v1.0.7 (*) │ │ ├── lazr-restfulclient v0.14.6 (*) │ │ ├── lazr-uri v1.0.7 (*) │ │ ├── overrides v7.7.0 │ │ ├── pydantic v2.11.3 │ │ │ ├── annotated-types v0.7.0 │ │ │ ├── pydantic-core v2.33.1 │ │ │ │ └── typing-extensions v4.13.2 │ │ │ ├── typing-extensions v4.13.2 │ │ │ └── typing-inspection v0.4.0 │ │ │ └── typing-extensions v4.13.2 │ │ └── python-debian v0.1.49 │ │ └── chardet v5.2.0 │ ├── craft-cli v3.0.0 │ │ ├── jinja2 v3.1.6 │ │ │ └── markupsafe v3.0.2 │ │ ├── overrides v7.7.0 │ │ ├── platformdirs v4.3.7 │ │ └── typing-extensions v4.13.2 │ ├── craft-grammar v2.0.3 │ │ ├── overrides v7.7.0 │ │ └── pydantic v2.11.3 (*) │ ├── craft-parts v2.10.0 │ │ ├── overrides v7.7.0 │ │ ├── pydantic v2.11.3 (*) │ │ ├── pyxdg v0.28 │ │ ├── pyyaml v6.0.2 │ │ ├── requests v2.32.3 │ │ │ ├── certifi v2025.4.26 │ │ │ ├── charset-normalizer v3.4.1 │ │ │ ├── idna v3.10 │ │ │ └── urllib3 v2.4.0 │ │ └── requests-unixsocket2 v1.0.0 │ │ ├── requests v2.32.3 (*) │ │ └── urllib3 v2.4.0 │ ├── craft-platforms v0.8.0 │ │ ├── annotated-types v0.7.0 │ │ ├── distro v1.9.0 │ │ └── typing-extensions v4.13.2 │ ├── craft-providers v2.2.0 │ │ ├── packaging v25.0 │ │ ├── pydantic v2.11.3 (*) │ │ ├── pyyaml v6.0.2 │ │ ├── requests v2.32.3 (*) │ │ └── requests-unixsocket2 v1.0.0 (*) │ ├── jinja2 v3.1.6 (*) │ ├── license-expression v30.4.1 │ │ └── boolean-py v5.0 │ ├── platformdirs v4.3.7 │ ├── pydantic v2.11.3 (*) │ ├── pygit2 v1.13.3 │ │ ├── cffi v1.17.1 │ │ │ └── pycparser v2.22 │ │ └── setuptools v80.0.0 │ ├── pyyaml v6.0.2 │ ├── requests v2.32.3 (*) │ ├── snap-helpers v0.4.2 │ │ └── pyyaml v6.0.2 │ ├── typing-extensions v4.13.2 │ └── launchpadlib v2.1.0 (extra: remote) (*) ├── craft-archives v2.1.0 (*) ├── craft-cli v3.0.0 (*) ├── craft-grammar v2.0.3 (*) ├── craft-parts v2.10.0 (*) ├── craft-platforms v0.8.0 (*) ├── craft-providers v2.2.0 (*) ├── craft-store v3.2.1 │ ├── annotated-types v0.7.0 │ ├── httpx v0.28.1 │ │ ├── anyio v4.9.0 │ │ │ ├── idna v3.10 │ │ │ ├── sniffio v1.3.1 │ │ │ └── typing-extensions v4.13.2 │ │ ├── certifi v2025.4.26 │ │ ├── httpcore v1.0.9 │ │ │ ├── certifi v2025.4.26 │ │ │ └── h11 v0.16.0 │ │ └── idna v3.10 │ ├── jaraco-classes v3.4.0 │ │ └── more-itertools v10.7.0 │ ├── keyring v25.6.0 │ │ ├── jaraco-classes v3.4.0 (*) │ │ ├── jaraco-context v6.0.1 │ │ ├── jaraco-functools v4.1.0 │ │ │ └── more-itertools v10.7.0 │ │ ├── jeepney v0.9.0 │ │ └── secretstorage v3.3.3 │ │ ├── cryptography v44.0.2 │ │ │ └── cffi v1.17.1 (*) │ │ └── jeepney v0.9.0 │ ├── macaroonbakery v1.3.4 │ │ ├── protobuf v6.30.2 │ │ ├── pymacaroons v0.13.0 │ │ │ ├── pynacl v1.5.0 │ │ │ │ └── cffi v1.17.1 (*) │ │ │ └── six v1.17.0 │ │ ├── pynacl v1.5.0 (*) │ │ ├── pyrfc3339 v1.1 │ │ │ └── pytz v2025.2 │ │ ├── requests v2.32.3 (*) │ │ └── six v1.17.0 │ ├── overrides v7.7.0 │ ├── pydantic v2.11.3 (*) │ ├── pyxdg v0.28 │ ├── requests v2.32.3 (*) │ ├── requests-toolbelt v1.0.0 │ │ └── requests v2.32.3 (*) │ └── typing-extensions v4.13.2 ├── cryptography v44.0.2 (*) ├── gnupg v2.3.1 │ └── psutil v7.0.0 ├── jsonschema v2.5.1 ├── launchpadlib v2.1.0 (*) ├── lazr-restfulclient v0.14.6 (*) ├── lxml v5.4.0 ├── macaroonbakery v1.3.4 (*) ├── mypy-extensions v1.1.0 ├── overrides v7.7.0 ├── packaging v25.0 ├── progressbar v2.5 ├── pydantic v2.11.3 (*) ├── pyelftools v0.32 ├── pygit2 v1.13.3 (*) ├── pylxd v2.3.5 │ ├── cryptography v44.0.2 (*) │ ├── python-dateutil v2.9.0.post0 (*) │ ├── requests v2.32.3 (*) │ ├── requests-toolbelt v1.0.0 (*) │ └── ws4py v0.6.0 ├── python-debian v0.1.49 (*) ├── pyxdg v0.28 ├── pyyaml v6.0.2 ├── raven v6.10.0 ├── requests v2.32.3 (*) ├── requests-toolbelt v1.0.0 (*) ├── requests-unixsocket2 v1.0.0 (*) ├── simplejson v3.20.1 ├── snap-helpers v0.4.2 (*) ├── tabulate v0.9.0 ├── tinydb v4.8.2 ├── toml v0.10.2 ├── typing-extensions v4.13.2 ├── validators v0.34.0 ├── coverage v7.8.0 (group: dev) ├── fixtures v4.2.5 (group: dev) ├── mccabe v0.7.0 (group: dev) ├── pexpect v4.9.0 (group: dev) │ └── ptyprocess v0.7.0 ├── pip v25.1 (group: dev) ├── pycodestyle v2.13.0 (group: dev) ├── pyflakes v3.3.2 (group: dev) ├── pyftpdlib v2.0.1 (group: dev) │ ├── pyasynchat v1.0.4 │ │ └── pyasyncore v1.0.4 │ └── pyasyncore v1.0.4 ├── pymacaroons v0.13.0 (group: dev) (*) ├── pyramid v2.0.2 (group: dev) │ ├── hupper v1.12.1 │ ├── plaster v1.1.2 │ ├── plaster-pastedeploy v1.0.1 │ │ ├── pastedeploy v3.1.0 │ │ └── plaster v1.1.2 │ ├── setuptools v80.0.0 │ ├── translationstring v1.4 │ ├── venusian v3.1.1 │ ├── webob v1.8.9 │ ├── zope-deprecation v5.1 │ │ └── setuptools v80.0.0 │ └── zope-interface v7.2 │ └── setuptools v80.0.0 ├── pytest v8.3.5 (group: dev) │ ├── iniconfig v2.1.0 │ ├── packaging v25.0 │ └── pluggy v1.5.0 ├── pytest-check v2.5.3 (group: dev) │ └── pytest v8.3.5 (*) ├── pytest-cov v6.1.1 (group: dev) │ ├── coverage v7.8.0 │ └── pytest v8.3.5 (*) ├── pytest-mock v3.14.0 (group: dev) │ └── pytest v8.3.5 (*) ├── pytest-subprocess v1.5.3 (group: dev) │ └── pytest v8.3.5 (*) └── testscenarios v0.5.0 (group: dev) ├── pbr v6.1.1 │ └── setuptools v80.0.0 └── testtools v2.7.2 └── setuptools v80.0.0 (*) Package tree already displayed ```

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged PR #5510 as commit 631682a34, correcting the confinement docstring and replacing outdated or broken Snapcraft, scriptlet, and craftctl documentation links.
stealth/space-bunny-alpha — closed resolved Merged as commit 631682a34, fixing the confinement docstring and replacing outdated or broken Snapcraft, scriptlet, and craftctl documentation links.
stealth/space-bunny-alpha — closed resolved Merged #5510: corrected the confinement key docstring and replaced broken snapcraft.io, scriptlet, and craftctl references in Snapcraft documentation.
qwen/qwen3.6-35b-a3b — — Merged documentation update fixing the confinement docstring typo, replacing outdated snapcraft.io and RTD links, and correcting broken scriptlet and craftctl references. CI passed. Commit message adjusted to match conventions before merge.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation updates replacing snapcraft.io links, fixing the confinement key docstring typo, and correcting broken scriptlet and craftctl references. Commits were adjusted to match conventions before squashing and merging.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#6048 docs: correct 'craftctl' to 'snapctl' in config doc snapcraft merged Merged #6048 via 2d3bec6c7, correcting the config guide from craftctl to snapctl. The intersphinx link update was intentionally deferred to separate work.
76%
#5743 docs: fix service management to snapctl snapcraft merged Merged docs PR #5743 (commit 40851bddd) fixed the snapcraft.yaml daemon reference: replaced craftctl with snapctl for runtime service management and corrected the intersphinx link. Fixes #5738.
76%
#665 Update broken links to https://snapcraft.io snapcraft merged PR #665 merged as commit df3c4b880 (July 2016): 7 files changed to swap broken https://snapcraft.io links for http://snapcraft.io and replace the dead /create#begin anchor with /create#tour, fixing snapcraft.io bugs #111 and #112.
74%
#1091 docs: revamp craftctl how-to craft-parts merged Merged PR #1091 as 44aa6508, revamping the craftctl how-to with upstream Snapcraft guidance and adding a 2.10.0 changelog entry.
73%
#5528 chore: address all snapcraft.io/docs links snapcraft merged Merged PR #5528 (commits 3c79e106e/796556ccc) updated remaining snapcraft.io/docs links across 91 files (+551/-550); Ubuntu 20.04 spread test failed but did not block merge. Follow-up link fixes landed in #5921.
72%
#5924 docs: clean up 'snapcraft.yaml' snapcraft merged Merged snapcraft.yaml documentation cleanup in #5924 via commit 83f961ebc, upgrading pydantic-kitbash, correcting docstrings and links, and regenerating the JSON schema.
72%
#4276 docs: replace placeholder docs with the real ones snapcraft closed Merged PR #4276 replaced placeholder Snapcraft documentation with the real docs, changing 454 files (+36,327/−393 lines).
71%
#6227 docs: small updates for latest pattern compliance snapcraft merged Docs-only PR #6227 merged as commit 915e402dd: reorganised snapcraft.yaml explanation into an 'About snapcraft.yaml' doc, rewrote/trimmed examples (dropped yt-dlp, updated wethr to core26), flattened references, added 'About' prefixes to overlapping titles, and added how-to landing pages.
71%
#6107 docs: improve the contribution guides more snapcraft merged Merged documentation improvements in snapcraft#6107 via commit aced3d1aa, refining the commit workflow, testing guidance, and link accessibility.
71%
#864 Update documentation links to developer.ubuntu.com that now redirect … snapcraft merged Merged PR #864 as commit a309efa4e, replacing three obsolete developer.ubuntu.com documentation links with their snapcraft.io destinations.
71%