Parts repository is undocumented
Metadata
Current evaluation
Docs gap on the parts repository fixed by ubuntu-core/snapcraft PR #527 (commit 8a64112fe), adding wiki links and guidance on importing/reusing parts; shipped in snapcraft 2.12 SRU to xenial -updates, LP bug closed.
Resolution: closed resolved
Reason: The issue was resolved by ubuntu-core/snapcraft PR #527 (commit 8a64112fe) as noted in the first comment by ~elopio, which improved the parts documentation with wiki links and details on how parts are imported/reused. The change was SRU'd as snapcraft 2.12 to xenial -updates, verified by ~arges, and the verification-needed tag was cleared.
Evaluated by: mr-cal-bot
No scores available.
Issue body
We discussed in the sprint that there aren't too many contributions for parts, and I have a hint about why: it's not documented.
This is the documentation for parts:
https://developer.ubuntu.com/en/snappy/build-apps/snapcraft-parts/
It doesn't even mention the idea of parts being imported, which means it also doesn't mention the location for such details.
Then, in the advanced section, it is very tersely mentioned:
"""
As we never define the curl part in the above example, snapcraft will check the Ubuntu Wiki, which is where we currently host examples of successful snapcraft parts.
"""
Again, no proper coverage, and no links to where these are actually defined.
The only place I could find a link to the wiki location is inside the snapcraft.yaml syntax definition:
"""
plugin: Specifies the plugin name that will manage this part. Snapcraft will pass to it all the other user-specified part options. If plugin is not defined, the wiki will be searched for the part
"""
Again, super terse and hidden in a non-obvious place. I could only find it because I knew what I was looking for.
Most people will never even know about this feature.
[Impact]
* The parts wiki is not well documented.
[Test Case]
* Read the new snapcraft parts docs.
[Regression Potential]
* N/A. This is only a documentation change.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Docs gap on the parts repository fixed by ubuntu-core/snapcraft PR #527 (commit 8a64112fe), adding wiki links and guidance on importing/reusing parts; shipped in snapcraft 2.12 SRU to xenial -updates, LP bug closed. | |
| stealth/space-bunny-alpha | — | closed resolved | Docs gap on parts repository fixed by PR #527 (commit 8a64112fe), adding parts-wiki links and guidance on importing/reusing parts; shipped in snapcraft 2.12 SRU to xenial -updates, LP bug closed. | |
| stealth/space-bunny-alpha | — | closed resolved | Documentation was added for reusable parts, including parts-wiki links and import/reuse guidance, via merged canonical/snapcraft#527 (commit 8a64112fe). | |
| qwen/qwen3.6-35b-a3b | — | — | Documentation updated to cover the snapcraft parts repository, including import functionality and wiki links. Issue closed as verified. | |
| qwen/qwen3.6-35b-a3b | — | — | Documentation updated to properly cover the parts repository import feature, including clear links and explanations. Verified and closed. | |
| qwen/qwen3.6-35b-a3b | — | — | Fixed by updating documentation to properly cover the parts repository and import feature, including direct wiki links. Verified and closed. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Documentation was updated to clearly cover the parts repository import feature and provide direct references. Changes verified and issue closed. |
Update history
| Date | Change |
|---|---|
| created |
Related work
-
Likely Fixed By:
ubuntu-core/snapcraft#527
(confidence 95%)
~elopio linked this PR in the first comment as the change that resolves the documentation gap.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #527 Add more info about reusable parts. | snapcraft | merged | Merged PR canonical/snapcraft#527 (8a64112fe), adding parts-wiki links and documentation explaining how to reuse parts. |