docs: clean up 'snapcraft.yaml'
Metadata
Current evaluation
Merged snapcraft.yaml documentation cleanup in #5924 via commit 83f961ebc, upgrading pydantic-kitbash, correcting docstrings and links, and regenerating the JSON schema.
Resolution: closed resolved
Reason: PR #5924 was approved and merged as commit 83f961ebc. The commit delivered the documented cleanup and schema updates.
Evaluated by: mr-cal-bot
No scores available.
Issue body
* Upgrade pydantic-kitbash to v0.1.1
* Remove unnecessary module declarations
* Replace internal docstring links with `ref` roles
* Fix various typos in docstrings
* Update JSON schema
Any nontrivial changes to content were sourced from the initial audit of this YAML documentation. A few of the descriptions got left out in previous passes.
I held off on adding the PackageRepository fields for now. Each type (Debian, PPA, UCA) has its own model that extends `PackageRepository`, so I'd rather we take our time in considering how we want to organize the common and model-specific keys.
[Rendered page](https://canonical-ubuntu-documentation-library--5924.com.readthedocs.build/snapcraft/5924/reference/project-file/snapcraft-yaml/)
---
- [x] I've followed the [contribution guidelines](https://github.com/canonical/snapcraft/blob/main/CONTRIBUTING.md).
- [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/).
- [ ] I've successfully run `make lint && make test`.
- [ ] I've added or updated any relevant documentation.
- [ ] I've updated the relevant release notes.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged snapcraft.yaml documentation cleanup in #5924 via commit 83f961ebc, upgrading pydantic-kitbash, correcting docstrings and links, and regenerating the JSON schema. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged the snapcraft.yaml docs cleanup: upgraded pydantic-kitbash, removed redundant model declarations, fixed docstring links and typos, and regenerated the JSON schema. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged snapcraft.yaml documentation cleanup: upgraded pydantic-kitbash to v0.1.1, removed redundant modules, corrected docstrings and links, and regenerated the JSON schema. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation cleanup for snapcraft.yaml, including typo fixes, docstring link updates, and JSON schema regeneration. Reviewers approved the non-functional changes, and the schema workflow was resolved by running make schema. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation cleanup for snapcraft.yaml. Updates upgrade pydantic-kitbash, fix typos, replace docstring links, and regenerate the JSON schema. The failing workflow was resolved by committing the updated schema. All changes were purely descriptive. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #5665 docs: clean up 'snapcraft.yaml' | snapcraft | merged | Merged docs cleanup in #5665 (30ab2b049): upgraded pydantic-kitbash to 0.0.7, removed library modules from sys.path, and declared currentmodule for Part Properties. | |
| #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. | |
| #5466 docs: migrate 'snapcraft.yaml' | snapcraft | merged | Merged the snapcraft.yaml documentation migration into the Read the Docs project-file reference via commit 2670e8278 (#5466). | |
| #245 docs: clean up 'imagecraft.yaml' | imagecraft | merged | Merged as 3f819e5: upgraded pydantic-kitbash to v0.1.1, removed legacy workarounds, and cleaned up typos and language in the imagecraft.yaml documentation. | |
| #221 Documentation refresh. | snapcraft | merged | Merged in canonical/snapcraft#221 via 08d274af5, updating six files (+237/-183) for Snapcraft 2.0 YAML keywords and lifecycle changes. | |
| #1056 docs: clean up 'rockcraft.yaml' | rockcraft | merged | Merged PR #1056 as commit 32d800b9, upgrading pydantic-kitbash to v0.1.1 and cleaning rockcraft.yaml docs by removing redundant modules and normalizing field order. | |
| #5743 docs: fix service management to snapctl | snapcraft | merged | Merged docs PR #5743 (commit 40851bddd) fixed the snapcraft.yaml daemon reference: replaced craftctl with snapctl for runtime service management and corrected the intersphinx link. Fixes #5738. | |
| #146 Syntax of snapcraft.yaml (1.x) | snapcraft | merged | PR #146 was merged, updating the snapcraft.yaml 1.x syntax reference after review, rebase, and squash; it built on merged PR #131. | |
| #5422 docs: add tutorial | snapcraft | merged | Merged PR #5422 as commit 5c50c42d4, adding a new Snapcraft tutorial and revising 10 documentation files (+795/-90 lines). | |
| #5510 docs: replace some snapcraft.io links and fix confinement key docstring | snapcraft | merged | Merged PR #5510 as commit 631682a34, correcting the confinement docstring and replacing outdated or broken Snapcraft, scriptlet, and craftctl documentation links. |