docs: update yaml reference
Metadata
Current evaluation
Merged PR #156 as commit 1dbd410, automating the imagecraft.yaml reference with Kitbash and field docstrings added in PR #153.
Resolution: closed resolved
Reason: PR #156 passed all CI checks, received approval, and was merged into main as commit 1dbd410. It replaced manually maintained YAML reference content with Kitbash-generated documentation.
Evaluated by: mr-cal-bot
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 |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #156 as commit 1dbd410, automating the imagecraft.yaml reference with Kitbash and field docstrings added in PR #153. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged documentation update automating imagecraft.yaml reference content with Kitbash and docstrings from imagecraft#153, in commit 1dbd410 (#156). | |
| 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. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/imagecraft#153
(confidence 99%)
Merged as commit 8c94407; it added the Pydantic field docstrings used by #156 to generate the YAML reference.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #173 docs: update 'imagecraft.yaml' | imagecraft | merged | Merged the imagecraft.yaml documentation update, reordering part keys and documenting organize, in PR #173 (commit d46f752). | |
| #774 docs: update name description | craft-application | merged | Merged PR #774 (commit 964f5d92) updated the name-field docs for Kitbash rendering, aligned wording with Snapcraft, and corrected other descriptions. | |
| #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. | |
| #259 docs: incorporate Kitbash 1.0 | imagecraft | merged | Merged as canonical/imagecraft#259 (commit b1d6658): bumped pydantic-kitbash to v1.0 (new kitbash-field directives) and renamed imagecraft-yaml-file.rst to imagecraft-yaml.rst. Snap build failure was noted as unrelated. | |
| #189 docs: clean up 'imagecraft.yaml' | imagecraft | merged | Merged in bfe4f70: updated pydantic-kitbash to v0.0.7, removed library modules from sys.path, and added currentmodule directives to clean up the imagecraft.yaml docs. | |
| #293 docs: reorder 'imagecraft.yaml' reference | imagecraft | merged | Merged in canonical/imagecraft#293 via commit 314f01d, aligning the imagecraft.yaml reference with the init template by placing volume and filesystem keys before part keys. | |
| #153 docs: add docstrings to Pydantic fields | imagecraft | merged | Merged PR #153 into main as 8c94407, adding Pydantic field docstrings, the Kitbash documentation dependency, and a draft rendered YAML reference. | |
| #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. | |
| #109 docs: Clean and document new fields | imagecraft | merged | Merged as commit 5b05ae3 ("docs: Clean and document new fields (#109)"): documented overlay, volumes and other common imagecraft.yaml fields, removed ubuntu-image references, and added a more representative example (+258/-530 across 22 files). |