feat(docs): add definition for overlay_step in the docs
Metadata
Current evaluation
Merged into Rockcraft, PR #436 added the missing overlay-step definition; maintainers chose its local wording instead of delaying for shared Craft Parts documentation.
Resolution: closed resolved
Reason: canonical/rockcraft#436 received three approvals and was merged, adding the definition to docs/explanation/overlay-step.rst. Maintainer tigarmo explicitly chose to merge the paragraph as-is while Craft Parts documentation sharing was reconsidered.
Evaluated by: mr-cal-bot
No scores available.
Issue body
- [X] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
-----
I added the missing definition for the overlay-step in explanation docs.
Note that the overlay_parameters common doc mentions `overlay-filters` field, but apparently that's a typo and it should be `overlay-files`. I fixed that in rockcraft docs, but it needs to be fixed in craft-parts docs too.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged into Rockcraft, PR #436 added the missing overlay-step definition; maintainers chose its local wording instead of delaying for shared Craft Parts documentation. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #436, adding the missing overlay_step definition to Rockcraft's explanation docs; broader reuse of Craft Parts documentation was deferred. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #436 as commit 0733ac59, adding the missing overlay-step definition to Rockcraft's explanation documentation. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged as commit 0733ac59, adding the missing overlay-step definition to Rockcraft documentation. | |
| stealth/space-bunny-alpha | — | closed resolved | Added the missing overlay_step documentation in a six-line change and merged it as-is. Resolving commit: 0733ac59. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged as 0733ac59, adding the missing overlay_step definition to Rockcraft's documentation. | |
| stealth/space-bunny-alpha | — | closed resolved | PR #436 by linostar merged as commit 0733ac59, adding docs/explanation/overlay-step.rst defining the overlay step in the rock parts lifecycle; craft-parts#137 (1a813210) enabled the include. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #436 added Rockcraft documentation for overlay-step; the change is also referenced by canonical/craft-parts#137 at commit 1a813210. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/craft-parts#137 (1a813210), adding the missing overlay-step definition to the documentation. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update adding the missing overlay_step definition to Rockcraft docs. Maintainers chose to merge the standalone paragraph as-is, deferring upstream craft-parts doc inheritance improvements for later. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged the addition of the missing overlay_step definition to the documentation. Maintainers opted to merge the standalone paragraph as-is for now, deferring upstream inheritance from craft-parts pending repo updates. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/craft-parts#137
(confidence 85%)
Shared Craft Parts overlay documentation work discussed as an alternative, although #436 was merged independently.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #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. | |
| #370 docs: explanation section for overlays | craft-parts | merged | Merged PR #370 as commit a90caeb4, adding overlay documentation and incorporating #365’s lifecycle changes; it resolved CRAFT-1560. | |
| #795 docs: add labels for overlay step | craft-parts | merged | Merged in canonical/craft-parts#795 via commit 63145713, adding labels so overlay-step references remain valid when explanation pages are excluded. | |
| #1165 feat: enable override-overlay | rockcraft | merged | Merged in rockcraft#1165 via commit 1024f092, enabling override-overlay, updating a spread test from overlay-script, and documenting the key. | |
| #765 docs: fix explanation pages | craft-parts | merged | Merged as 2ae355df, proofreading and updating Craft Parts and Rockcraft explanation pages; missing overlay labels were handled in follow-up #795. |