docs: add snapcraft.yaml reference
Metadata
Current evaluation
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.
Suggested action: —
No scores available.
Issue body
- [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`?
---
* Add pydantic-kitbash to the project
* Add docstrings for all fields in project.py
* Remove key names from field examples
* Add basic rST directives to generate a project file reference document
All docstring content was pulled from [this spreadsheet](https://docs.google.com/spreadsheets/d/10EBtAqA56bxio39UxaewIhrrWHZIhWzhNB3amFGi0vY/edit?usp=sharing).
[RTD build](https://canonical-snapcraft--5421.com.readthedocs.build/en/5421/reference/snapcraft-yaml.html)
Edit: Currently pulling kitbash from the repo's main branch to demonstrate the most recent changes. This will be switched back to PyPI before merging.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update adding a snapcraft.yaml reference. Integrates pydantic-kitbash, generates rST docs from project.py docstrings, and updates the build to source kitbash from PyPI. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update adding a snapcraft.yaml reference page. Content generated from project.py docstrings and a reference spreadsheet. Dependency source switched from repository main to PyPI prior to merge. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #259 docs: incorporate Kitbash 1.0 | imagecraft | merged | Merged documentation update upgrading pydantic-kitbash to v1.0 and renaming the YAML reference file. Approved by three reviewers with passing CI checks. An unrelated snap build failure was noted but did not prevent the merge. | |
| #5566 docs: add part keys to `snapcraft.yaml` reference | snapcraft | merged | 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. | |
| #96 Updated snapcraft.yaml for new Py deps. | charmcraft | merged | Updated snapcraft.yaml to include new Python dependencies. Merged after approval from two reviewers, adding 67 lines across two files. | |
| #5924 docs: clean up 'snapcraft.yaml' | snapcraft | merged | 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. | |
| #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. | |
| #245 docs: clean up 'imagecraft.yaml' | imagecraft | merged | Merged documentation cleanup for imagecraft.yaml. Updates include upgrading pydantic-kitbash to v0.1.1, removing legacy workarounds, fixing typos, and refining docstrings. Approved by two reviewers and successfully merged. | |
| #153 docs: add docstrings to Pydantic fields | imagecraft | merged | Merged after approval from two reviewers. Adds docstrings to Pydantic fields, includes Kitbash as a documentation dependency, and drafts a YAML reference. CI passed with minor spread test failures. Changes integrated into the main branch. | |
| #156 docs: update yaml reference | imagecraft | merged | Merged following approval and successful CI checks. Automates the imagecraft.yaml reference documentation using Kitbash, extracting content from docstrings in PR #153. Modified 5 files with +134/-210 lines. |