docs: clean up 'imagecraft.yaml'
Metadata
Current evaluation
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.
Suggested action: —
No scores available.
Issue body
* Upgrade pydantic-kitbash to v0.1.1
* Remove workarounds from previous Kitbash versions
* Fix typos and tidy up some language in the docstrings
[Rendered doc](https://canonical-imagecraft--245.com.readthedocs.build/245/reference/imagecraft-yaml-file/#reference-imagecraft-yaml)
---
- [X] I've followed the [contribution guidelines](https://github.com/canonical/imagecraft/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.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation cleanup for imagecraft.yaml. Updates include upgrading pydantic-kitbash to v0.1.1, removing legacy workarounds, and correcting typos and docstrings. Successfully integrated by maintainer jahn-junior. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation cleanup for imagecraft.yaml. The update upgrades pydantic-kitbash to v0.1.1, removes legacy workarounds, corrects typos, and refines docstrings. Successfully integrated into the main branch. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #1056 docs: clean up 'rockcraft.yaml' | rockcraft | merged | Merged documentation cleanup for rockcraft.yaml. Updates include upgrading pydantic-kitbash to v0.1.1, removing unnecessary module declarations, and normalizing field order. Approved by two reviewers and merged despite unrelated snap-test failures. | |
| #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. | |
| #5972 docs: incorporate pydantic-kitbash 1.0.0 | snapcraft | merged | Merged following approval by two reviewers. Updated pydantic-kitbash to 1.0.0, removed redundant label overrides, and updated YAML key references to match the new label format. Six files changed. | |
| #436 docs: Imagecraft 1.0 release notes | imagecraft | merged | Merged following approval by two reviewers and successful CI execution. The change adds documentation for the Imagecraft 1.0 release notes across six files, introducing 82 lines and removing 34. |