snapcraft.yaml reference documentation missing descriptions for part keys
Metadata
Current evaluation
Missing part-key descriptions in the new snapcraft.yaml reference were added by merged PR #5566 (commit aee7fe47c), shipped in Snapcraft 8.9.5; tracked internally as CRAFT-4488/SNAPCRAFT-1145 and issue closed by mr-cal.
Resolution: closed resolved
Reason: Maintainer mr-cal closed the issue on 2025-08-29 pointing to canonical/snapcraft PR #5566, which was merged as commit aee7fe47c ("docs: add part keys to `snapcraft.yaml` reference") and released in Snapcraft 8.9.5, adding the missing part-key descriptions to the reference page.
Evaluated by: mr-cal-bot
No scores available.
Issue body
### What needs to get done
The part keys in the new [snapcraft.yaml reference](https://documentation.ubuntu.com/snapcraft/latest/reference/project-file/snapcraft-yaml/#part-keys) miss the original descriptions (see [forum](https://forum.snapcraft.io/t/snapcraft-yaml-schema/4276)).
### Why it needs to get done
Descriptions should be added. It is hard to guess the syntax and advanced grammar support without them.
(Also, it would be nice to have a new issue type for documentation issues)
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Missing part-key descriptions in the new snapcraft.yaml reference were added by merged PR #5566 (commit aee7fe47c), shipped in Snapcraft 8.9.5; tracked internally as CRAFT-4488/SNAPCRAFT-1145 and issue closed by mr-cal. | |
| stealth/space-bunny-alpha | — | closed resolved | Missing part-key descriptions in the snapcraft.yaml reference were added by merged PR #5566 (commit aee7fe47c), shipped in Snapcraft 8.9.5; issue closed 2025-08-29 by mr-cal. | |
| stealth/space-bunny-alpha | — | closed resolved | Part-key descriptions were added to the snapcraft.yaml reference by merged PR #5566, resolving the documentation gap in commit aee7fe47c. | |
| qwen/qwen3.6-35b-a3b | — | — | Missing snapcraft.yaml part key descriptions were added and integrated with Craft Parts source code. The documentation update was completed and merged via pull request #5566 in the canonical/snapcraft repository. | |
| qwen/qwen3.6-35b-a3b | — | — | Missing descriptions for part keys in the snapcraft.yaml reference documentation were resolved. PR #5566 merged the fix, integrating the descriptions with the Craft Parts source code to ensure consistency across all craft tools. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Missing descriptions for snapcraft.yaml part keys were added by integrating documentation with the Craft Parts source code. The fix was completed and merged in pull request #5566, ensuring consistent reference documentation across craft tools. |
Update history
No update history recorded yet.
Related work
-
Likely Fixed By:
canonical/snapcraft#5566
(confidence 97%)
Merged PR 'docs: add part keys to `snapcraft.yaml` reference' (commit aee7fe47c), the resolution explicitly cited in the closing comment.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #5566 docs: add part keys to `snapcraft.yaml` reference | snapcraft | merged | Merged PR #5566 (commit aee7fe47c, "docs: add part keys to snapcraft.yaml reference") added updated part-key descriptions to the snapcraft.yaml reference; approved by 2 reviewers and shipped in Snapcraft 8.9.5. | |
| #5681 docs: document the base key | snapcraft | merged | Merged PR #5681 in commit caf905ce5, adding 17 lines documenting the snapcraft.yaml base key. |