docs: update yaml reference
Metadata
Current evaluation
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.
Suggested action: —
No scores available.
Issue body
- [X] Have you followed the guidelines for contributing?
- [X] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [X] Have you successfully run `make lint && make test`?
---
This PR automates the content of the imagecraft.yaml reference with [Kitbash](https://github.com/canonical/pydantic-kitbash). The content of each key entry is pulled from the docstrings added in https://github.com/canonical/imagecraft/pull/153.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged automation for the imagecraft.yaml reference documentation using Kitbash. The update extracts key descriptions from docstrings added in PR #153, keeping the generated reference synchronized with the codebase. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged automated documentation update for the imagecraft.yaml reference. Replaces manual entries with dynamically generated content pulled from docstrings via Kitbash, ensuring consistent API documentation. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #173 docs: update 'imagecraft.yaml' | imagecraft | merged | Merged documentation update for imagecraft.yaml. Changes include reordering part keys and adding a manual description to the organize directive. The request received reviewer approval, passed CI checks, and was successfully integrated. | |
| #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. | |
| #189 docs: clean up 'imagecraft.yaml' | imagecraft | merged | Merged documentation cleanup for imagecraft.yaml. Updated pydantic-kitbash to v0.0.7, removed library modules from sys.path, and added currentmodule directives to eliminate Kitbash warnings. Approved and passed CI. | |
| #293 docs: reorder 'imagecraft.yaml' reference | imagecraft | merged | Merged documentation update to reorder keys in the imagecraft.yaml reference. Aligns the reference with the init template by placing volume and filesystem keys before part keys. Approved and merged. | |
| #109 docs: Clean and document new fields | imagecraft | merged | Merged documentation updates for imagecraft.yaml covering overlay and volumes fields, cleaned ubuntu-image references, and an improved example. Approved by two reviewers, passed CI, and modified 22 files. | |
| #39 Document the imagecraft.yaml configuration file | imagecraft | merged | Merged documentation for the imagecraft.yaml configuration file. Approved by one reviewer with zero unresolved comments. Changes span 24 files, adding 1253 lines and removing 113. CI passed with 97.66% test coverage. Resolves FR-7038. | |
| #318 docs: automate CLI reference documentation | rockcraft | merged | Merged automated CLI reference documentation generation. Approved by three reviewers, passed CI checks, and updated five files. Implements CRAFT-1779 to streamline documentation updates. | |
| #5849 docs: fix YAML reference types | snapcraft | merged | Merged documentation fix correcting YAML reference types. Approved by two reviewers, passed all CI checks, and updated one file with six additions and two deletions. | |
| #2154 docs: replace occurrences of "charmcraft.yaml" and "recipe" | charmcraft | merged | Merged documentation update replacing charmcraft.yaml and recipe with project or project file across 23 files. Approved by two reviewers after minor clarity feedback. Changes span +155/-159 lines. | |
| #5508 docs: update YAML reference | snapcraft | closed | Closed by author to revisit docs after PartSpec finalization. Intended to update YAML reference, add platform and architecture models, and use Kitbash v0.0.4. Abandoned with 11 unresolved review comments and one failing CI check. |