← Back to issue list

docs: clean up 'imagecraft.yaml'

View original Github issue

Metadata

Project
imagecraft
Number
#245
Type
pull request
State
merged
Author
jahn-junior
Labels
—
Created
Updated
Closed

Current evaluation

Merged as 3f819e5: upgraded pydantic-kitbash to v0.1.1, removed legacy workarounds, and cleaned up typos and language in the imagecraft.yaml documentation.

Resolution: closed resolved

Reason: PR #245 was approved and merged into main as commit 3f819e5. It updated pydantic-kitbash and simplified the documentation by removing workarounds for earlier Kitbash versions.

Evaluated by: mr-cal-bot

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
stealth/space-bunny-alpha — closed resolved Merged as 3f819e5: upgraded pydantic-kitbash to v0.1.1, removed legacy workarounds, and cleaned up typos and language in the imagecraft.yaml documentation.
stealth/space-bunny-alpha — closed resolved Merged as commit 3f819e5: upgraded pydantic-kitbash to v0.1.1, removed legacy Kitbash workarounds, and cleaned up imagecraft.yaml docstrings and typos.
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.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#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.
94%
#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.
83%
#173 docs: update 'imagecraft.yaml' imagecraft merged Merged the imagecraft.yaml documentation update, reordering part keys and documenting organize, in PR #173 (commit d46f752).
77%
#5665 docs: clean up 'snapcraft.yaml' snapcraft merged Merged docs cleanup in #5665 (30ab2b049): upgraded pydantic-kitbash to 0.0.7, removed library modules from sys.path, and declared currentmodule for Part Properties.
75%
#156 docs: update yaml reference imagecraft merged Merged PR #156 as commit 1dbd410, automating the imagecraft.yaml reference with Kitbash and field docstrings added in PR #153.
74%
#5924 docs: clean up 'snapcraft.yaml' snapcraft merged Merged snapcraft.yaml documentation cleanup in #5924 via commit 83f961ebc, upgrading pydantic-kitbash, correcting docstrings and links, and regenerating the JSON schema.
73%