← Back to issue list

docs: add part keys to `snapcraft.yaml` reference

View original Github issue

Metadata

Project
snapcraft
Number
#5566
Type
pull request
State
merged
Author
medubelko
Labels
Created
Updated
Closed

Current evaluation

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.

Suggested action:

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
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.
qwen3.6-35b-a3b-mtp-q6 Merged documentation update adding updated descriptions for snapcraft.yaml part keys. Keys are organized by importance, prominence, build lifecycle, and alphabetical order. All checks passed.

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 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.
81%
#5571 docs: update 'snapcraft.yaml' key types snapcraft merged Merged documentation update improving type presentation for snapcraft.yaml keys and adding build-attributes headers. Targeted to main for the v8.10.0 release following reviewer approval and CI validation.
74%
#5421 docs: add snapcraft.yaml reference snapcraft merged Merged after three approvals. Added automated snapcraft.yaml reference documentation using pydantic-kitbash and rST directives. CI passed and the dependency was switched to PyPI before merge.
73%
#1031 docs: add new how-to for parts craft-parts merged Merged documentation update adding a generalized how-to guide for parts. Approved by three reviewers, the change adapts an existing Snapcraft page for broader use, updates the changelog, and adds 68 lines across four files.
73%
#786 Add `snapcraft list-keys` snapcraft merged Merged changes adding the snapcraft list-keys command to show store-registered keys. The author promptly resolved an initial CI test failure, reviewers approved the update, and the branch was merged.
71%
#6043 docs: remove duplicate app keys from 'snapcraft.yaml' snapcraft merged Merged after three approvals and passing CI checks. The update removes duplicate app keys from the snapcraft.yaml documentation, adding six lines and removing four across one file.
70%