← Back to issue list

docs: rockcraft.yaml reference

View original Github issue

Metadata

Project
rockcraft
Number
#297
Type
issue
State
closed
Author
shipperizer
Labels
—
Created
Updated
Closed

Current evaluation

Redirected to craft-parts documentation for `organize`; no Rockcraft PR or commit fixed the missing in-tree reference, and documentation integration was only planned.

Resolution: closed not a bug

Reason: The maintainer explained that all `parts` subfields come from craft-parts and linked its `organize` reference, noting that integration into Rockcraft docs was still in progress. No fixing PR or commit was recorded before closure.

Evaluated by: mr-cal-bot

No scores available.

Issue body

### Bug Description Missing reference for the `organize` field in the `rockcraft.yaml` The field [here](https://github.com/canonical/prometheus-rock/blob/main/rockcraft.yaml#L38) is not really documented ### To Reproduce Click on the "here" hyperlink ### Environment all ### rockcraft.yaml ```shell See link ``` ### Relevant log output ```shell See link ```

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed not a bug Redirected to craft-parts documentation for `organize`; no Rockcraft PR or commit fixed the missing in-tree reference, and documentation integration was only planned.
stealth/space-bunny-alpha — closed resolved Imported the Craft Parts reference, including organize, into Rockcraft via #308 (commit 13bf8368).
stealth/space-bunny-alpha — closed not a bug The missing organize reference was redirected to craft-parts documentation; no fixing PR or commit was recorded, and Rockcraft integration was still planned.
qwen/qwen3.6-35b-a3b — — Closed without fixing. Maintainer directed users to craft-parts documentation for the organize field, noting plans to integrate those docs into the rockcraft reference later.
qwen/qwen3.6-35b-a3b — — Closed. Maintainers clarified the organize field originates from craft-parts and directed users to the external craft-parts reference. Internal documentation integration is planned.
qwen/qwen3.6-35b-a3b — — Documentation gap for the organize field in rockcraft.yaml acknowledged. Maintainer directed users to craft-parts docs as a temporary reference, noting internal documentation integration is in progress. Issue closed without immediate fix.
qwen3.6-35b-a3b-mtp-q6 — — Closed. Clarified that the organize field is defined by the upstream craft-parts library. Users are directed to craft-parts documentation as a temporary solution, with plans to integrate it into the official reference later.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#289 docs: expand rockcraft.yaml reference rockcraft merged Merged into main via commit 654c9c01, reorganizing reference docs and expanding the rockcraft.yaml configuration reference across seven files.
78%
#247 docs: include some docs from craft-parts rockcraft closed PR pulling craft-parts docs into rockcraft was left unmerged and closed as redundant; the same docs refactor landed instead via rockcraft#515 (commit 5c2263f1, "refactor(docs): use more docs from craft-parts").
76%
#515 refactor(docs): use more docs from craft-parts rockcraft merged Merged #515 refactored Rockcraft docs to reuse Craft Parts pages via direct TOC links or local includes (commit 5c2263f1).
74%
#318 docs: automate CLI reference documentation rockcraft merged Merged PR #318 in commit ca1b1c20, automating Rockcraft's CLI reference documentation and implementing CRAFT-1779.
73%
#308 docs: imported the part properties reference from Craft Parts rockcraft merged Imported Craft Parts' part-properties reference into Rockcraft docs; PR #308 merged as 13bf8368 after upstream craft-parts#483 and #486 enabled and corrected the reusable documentation.
72%
#680 doc: missing overlay info in rockcraft.yaml reference rockcraft closed Overlay is now documented under parts.<part-name>.overlay in the generated rockcraft.yaml reference; #680 was closed as outdated after PR #1041, with no further patch required.
72%
#314 docs: clean up references to Craft Parts rockcraft closed Craft Parts documentation cleanup was folded into canonical/rockcraft#308, merged as commit 13bf8368, and #314 was closed.
70%
#1082 fix: reference slug path in for rockcraft.yaml #2 rockcraft merged Merged in canonical/rockcraft#1082 via commit cae91c7d, correcting the CLI’s rockcraft.yaml reference link to the documentation slug rockcraft-yaml.
70%