docs: clean up 'snapcraft.yaml'
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation cleanup for snapcraft.yaml. Updated JSON schema, fixed typos, and improved docstring links. Schema workflow failure was resolved by regenerating the schema via make schema. Changes are purely descriptive. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #5466 docs: migrate 'snapcraft.yaml' | snapcraft | merged | Merged documentation migration moving snapcraft.yaml build configuration content from snapcraft.io to ReadTheDocs. Content added to the project file index. Approved by two reviewers with all CI checks passing. | |
| #2446 Update schema/snapcraft.yaml | snapcraft | closed | Superseded by pull request #2448. The schema/snapcraft.yaml update for YAML-to-JSON compatibility was closed without merging after reviewer feedback on Python test string handling and the decision to address the change in a replacement pull request. | |
| #5665 docs: clean up 'snapcraft.yaml' | snapcraft | merged | Merged documentation cleanup for snapcraft.yaml. Updated pydantic-kitbash to v0.0.7, removed library modules from sys.path, and added currentmodule directives to resolve Kitbash warnings. Approved by two reviewers, passed CI, and modified four files. | |
| #146 Syntax of snapcraft.yaml (1.x) | snapcraft | merged | Merged after rebasing to resolve diff conflicts and squashing commits. The pull request updates snapcraft.yaml (1.x) syntax and received final approval before integration. | |
| #2448 Swap yaml schema document with json equivalent | snapcraft | merged | Merged conversion of the snapcraft YAML schema to JSON. Reviewers requested formatting adjustments for validation error messages, specifically removing line breaks and using echo.wrap. Approved, passed CI, and merged to master. | |
| #131 add document detailing the snapcraft.yaml syntax | snapcraft | merged | Successfully merged documentation detailing the snapcraft.yaml syntax. The author rebased changes to master and resolved a minor version control mix-up, integrating the new syntax reference guide into the repository. | |
| #419 Properly validate the schema | snapcraft | merged | Merged refactoring that consolidates schema validation logic and removes it from snapcraft.yaml. The changes were finalized after fixing failing autopackage tests and addressing reviewer feedback. | |
| #3526 project: validate snapcraft yaml before using it (CRAFT-55) | snapcraft | closed | Merged into master. Moves snapcraft YAML validation to get_project() to prevent errors during extension application and JSON schema checks. Approved by two reviewers. | |
| #6389 docs: fix version in Snapcraft 9 | snapcraft | merged | Merged documentation fix for Snapcraft 9 that updates the docs title to show major and minor versions for builds, with latest showing dev. Aligns with RTD slug simplification. Approved by two reviewers and merged. | |
| #58 changes to snapcraft.yaml, and version, for 0.2.0 | charmcraft | merged | Merged following single reviewer approval. Updated snapcraft.yaml and bumped project version to 0.2.0 across two files, adding 107 lines and removing 9. |