← Back to issue list

docs: clean up 'snapcraft.yaml'

View original Github issue

Metadata

Project
snapcraft
Number
#5665
Type
pull request
State
merged
Author
jahn-junior
Labels
Created
Updated
Closed

Current evaluation

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.

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`? --- * Update `pydantic-kitbash` to v0.0.7 * Remove library modules from `sys.path` * Clean up 'Part Properties' by declaring ..py:currentmodule:: Once Snapcraft is updated to the next Craft Parts release, this will get rid of the Kitbash warnings in docs builds.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b 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.
qwen3.6-35b-a3b-mtp-q6 Merged documentation cleanup for snapcraft.yaml. Updated pydantic-kitbash to v0.0.7, removed library modules from sys.path, and added a py:currentmodule directive. Eliminates Kitbash warnings in docs builds without altering rendered content.
qwen3.6-35b-a3b-mtp-q6 Merged docs cleanup for snapcraft.yaml. Updated pydantic-kitbash to v0.0.7, removed library modules from sys.path, and fixed Part Properties formatting. Eliminates Kitbash warnings without altering rendered content.

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.
87%
#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.
82%
#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.
80%
#5421 docs: add snapcraft.yaml reference snapcraft merged 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.
79%
#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.
77%
#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.
76%
#1196 docs: clean up 'Part Properties' craft-parts merged Merged documentation cleanup for Part Properties. Updated Kitbash to v0.0.7, fixed multiline examples, removed craft_parts from sys.path, and added currentmodule directive. Passed all CI checks and reviews, eliminating Kitbash warnings.
75%
#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.
75%
#983 build(deps): update dependency pydantic-kitbash to ~=0.1.1 (main) craft-application merged Successfully merged the pydantic-kitbash dependency update from 0.0.7 to 0.1.1. Approved by two reviewers, all required CI checks passed, and the change was applied to the main branch across two files.
73%
#913 Update dependencies, bring in pydantic-kitbash rockcraft merged Merged after two approvals and passing all CI checks. The update refreshes dependencies and integrates pydantic-kitbash, modifying ten files with 3588 additions and 393 deletions.
73%