docs: add part keys to `snapcraft.yaml` reference
Metadata
Current evaluation
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.
Resolution: closed resolved
Reason: The PR itself was merged into main as commit aee7fe47c, updating the part key docs (+155/-12 across 4 files). The change is recorded in the 8.9.5 release notes: "Updated all part keys in the snapcraft.yaml reference".
Evaluated by: mr-cal-bot
No scores available.
Issue body
Add the updated part key descriptions.
The hard part with this change is the order of the keys. I opted for combining importance, prominence, build lifecycle, and lastly alphabetical.
Passed on `test-fast`.
---
- [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`?
- [x] Have you successfully run `make test`?
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | 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. | |
| stealth/space-bunny-alpha | — | closed resolved | Documentation-only PR merged as commit aee7fe47c, adding updated descriptions of all part keys to the snapcraft.yaml reference (docs/explanation/snapcraft-yaml.rst). Shipped in Snapcraft 8.9.5. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #5566 added updated part-key descriptions to the snapcraft.yaml reference in commit aee7fe47c. The change was approved by two reviewers and passed fast tests. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update adding updated part key descriptions to the snapcraft.yaml reference. Keys are ordered by importance, prominence, build lifecycle, and alphabetically. Approved by two reviewers and passed CI checks. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update adding and reorganizing part key descriptions for snapcraft.yaml. Keys are ordered by importance, prominence, build lifecycle, and alphabetically. All tests passed and changes were accepted. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #5511 snapcraft.yaml reference documentation missing descriptions for part keys | snapcraft | closed | 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. | |
| #5681 docs: document the base key | snapcraft | merged | Merged PR #5681 in commit caf905ce5, adding 17 lines documenting the snapcraft.yaml base key. | |
| #5421 docs: add snapcraft.yaml reference | snapcraft | merged | Merged PR #5421 as commit 8a046bb00, adding generated snapcraft.yaml reference docs, project field docstrings, and pydantic-kitbash integration; the dependency was restored to PyPI before merge. | |
| #5571 docs: update 'snapcraft.yaml' key types | snapcraft | merged | Merged PR #5571 updated snapcraft.yaml type presentation for parts, components, and package repositories, and added missing build-attributes headers. | |
| #6043 docs: remove duplicate app keys from 'snapcraft.yaml' | snapcraft | merged | Docs-only PR merged as commit 6a43e5742 ("docs: remove duplicate app keys from 'snapcraft.yaml'"), fixing a copy-paste duplication in the snapcraft.yaml reference after 3 approvals; +6/-4 lines in one doc file. |