extensions: use extension docstring
Metadata
Current evaluation
Merged into master. Replaces the generic snapcraft extension description with extension-specific docstrings, resolving bug LP: #1797655. Approved by reviewer and passed all CI checks.
Suggested action: —
No scores available.
Issue body
- [x] Have you followed the [guidelines for contributing](https://github.com/snapcore/snapcraft/blob/master/CONTRIBUTING.md)?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] If this is a bugfix. Have you checked that there is a bug report open for the issue you are trying to fix on [bug reports](https://bugs.launchpad.net/snapcraft)?
- [x] If this is a new feature. Have you discussed the design on the [forum](https://forum.snapcraft.io)?
- [x] Have you successfully run `./runtests.sh static`?
- [x] Have you successfully run `./runtests.sh tests/unit`?
-----
Currently, `snapcraft extension` is not the most obvious description of what the extension does or how to use it. This PR resolves [LP: #1797655](https://bugs.launchpad.net/snapcraft/+bug/1797655) by using documentation provided by the extension instead.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged into master. Replaces the generic snapcraft extension description with extension-specific docstrings, resolving bug LP: #1797655. Approved by reviewer and passed all CI checks. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged updates to the snapcraft extension command to display extension docstrings instead of hardcoded descriptions. Resolves LP: #1797655. Author kyrofa passed all tests with 100% diff coverage. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Updates the snapcraft extension command to display extension docstrings instead of generic descriptions, resolving Launchpad bug #1797655. Authored by maintainer kyrofa with 100% diff coverage. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #292 extensions: add cli commands | rockcraft | merged | Merged addition of list-extensions and expand-extensions CLI commands matching Snapcraft semantics, plus test refactoring. Resolves #274. Approved by two reviewers, passed CI, and modified 15 files (+452/-109 lines). | |
| #3679 Expand extensions | snapcraft | merged | Merged into snapcraft/7.0 after approval and passing CI checks. The changes expand extensions, address CRAFT-948, and increased overall coverage by 0.17%. | |
| #2348 extensions: remove root extensions | snapcraft | merged | Merged removal of root extension declarations from snapcraft.yaml. Resolves LP #1797631 by deferring application scope decisions until usage patterns clarify. Approved by maintainer, passed CI, and modified two files. | |
| #885 fix: Removed reference to snapcraft.yaml in expand extensions | rockcraft | open | One-line fix removing the snapcraft.yaml reference from the expand-extensions help text and docstring, fixing #658. Approved by 2 reviewers with all CI checks green, but unmerged and inactive ~6 months; the fix is still unapplied in the codebase. | |
| #4110 extensions: parse snapcraft.yaml before expanding extensions | snapcraft | merged | Merged fix for the expand-extensions command to parse snapcraft.yaml before expanding extensions. Resolves core22 parsing issues with parse-info and advanced grammar keywords. Approved, passed CI, and merged into main. | |
| #2347 extensions: support adding root properties | snapcraft | merged | Merged: extensions can now add YAML snippets to the root of snapcraft.yaml, resolving LP: #1794531. Approved by a reviewer, passed CI with 100% diff coverage, and modified three files. | |
| #1797655 `snapcraft extension` should be completely provided by the extension | snapcraft (launchpad) | closed | The proposal that snapcraft extensions fully provide their own documentation via extension-specific docstrings was closed without discussion or comments. No resolution details were provided, indicating the request was likely abandoned or superseded. | |
| #1103 fix: remove snapcraft.yaml reference from expand-extensions | rockcraft | open | Removes snapcraft.yaml references from expand-extensions help text and docstring (3 lines, 1 file). Approved with CI green, but inactive ~6 months; fix still unapplied in codebase; likely duplicate of older PR #885. |