← Back to issue list

doc: missing overlay info in rockcraft.yaml reference

View original Github issue

Metadata

Project
rockcraft
Number
#680
Type
issue
State
closed
Author
cjdcordeiro
Labels
—
Created
Updated
Closed

Current evaluation

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.

Resolution: closed not a bug

Reason: Maintainer @asanvaq closed #680 on 2026-03-24 as outdated, explicitly linking the now-present parts.<part-name>.overlay reference. Commit fd28a343 (PR #1041) had made the reference generated, so no additional issue-specific change was requested.

Evaluated by: mr-cal-bot

No scores available.

Issue body

The `part properties` should allude to the `overlay` step, at least pointing to where it is documented. --- Document: common/craft-parts/reference/part_properties.rst

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed not a bug 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.
stealth/space-bunny-alpha — closed not a bug Closed as outdated: the current rockcraft.yaml reference now documents parts.<part-name>.overlay; no additional change was needed.
stealth/space-bunny-alpha — closed not a bug Closed as outdated: the rockcraft.yaml reference now documents parts.<part-name>.overlay. Maintainer @asanvaq closed #680 on 2026-03-24; no code change was required.
stealth/space-bunny-alpha — closed not a bug Rockcraft’s rockcraft.yaml reference now documents the part overlay setting. The maintainer closed the request as outdated, with no code change required.
qwen/qwen3.6-35b-a3b — — Closed as outdated. The missing overlay step reference was already documented in the official Rockcraft reference. Maintainer @asanvaq confirmed the documentation exists and closed the issue without further action.
qwen/qwen3.6-35b-a3b — — Overlay documentation was added to the rockcraft.yaml reference, resolving the missing info request. The issue was closed as outdated after confirming the feature is now documented.
qwen/qwen3.6-35b-a3b — — Superseded by existing documentation. The missing overlay reference was already added to the official Rockcraft guide, so the issue was closed without further action.
qwen3.6-35b-a3b-mtp-q6 — — Resolved by adding documentation to the rockcraft.yaml reference. The issue was closed as outdated after a maintainer confirmed the overlay step details are now available at the official reference URL.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/rockcraft#1041 (confidence 90%)

    Commit fd28a343 generated the rockcraft.yaml reference, whose current part fields include overlay.

Related issues

Issue Project State Summary Similarity
#486 overlay-packages is not documented in rockcraft.yaml reference rockcraft open Documentation gap for overlay-packages in rockcraft.yaml part properties; maintainer confirmed it originates from craft-parts docs.
78%
#512 Document `overlay-packages` rockcraft open `overlay-packages` is now included in the unified rockcraft.yaml reference, and the former part-properties URL redirects to the new reference.
78%
#436 feat(docs): add definition for overlay_step in the docs rockcraft merged Merged into Rockcraft, PR #436 added the missing overlay-step definition; maintainers chose its local wording instead of delaying for shared Craft Parts documentation.
75%
#322 docs: enable inclusion of overlay document rockcraft merged Merged PR #322 in commit 181c9e1c, enabling inclusion of the Craft Parts overlay document in Rockcraft's documentation.
74%
#297 docs: rockcraft.yaml reference rockcraft closed Redirected to craft-parts documentation for `organize`; no Rockcraft PR or commit fixed the missing in-tree reference, and documentation integration was only planned.
72%