docs: add labels for overlay step
Metadata
Current evaluation
Merged in canonical/craft-parts#795 via commit 63145713, adding labels so overlay-step references remain valid when explanation pages are excluded.
Resolution: closed resolved
Reason: PR #795 was approved and merged as commit 63145713, resolving the broken overlay-step reference introduced in #765 and unblocking CRAFT-3043.
Evaluated by: mr-cal-bot
No scores available.
Issue body
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
-----
The reference to the overlay explanation added in #765 is a problem for applications that exclude the overlay explanation page.
See downstream usage: https://github.com/canonical/snapcraft/pull/4948
Unblocks CRAFT-3043
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/craft-parts#795 via commit 63145713, adding labels so overlay-step references remain valid when explanation pages are excluded. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #795 in commit 63145713, adding overlay-step labels so references remain valid when explanation pages are excluded; this unblocked CRAFT-3043. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/craft-parts#795 (commit 63145713), adding labels for the overlay step so excluded explanation pages no longer break the reference; unblocks CRAFT-3043. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update adding labels for the overlay step. Fixes a reference issue for applications excluding the overlay explanation page and unblocks CRAFT-3043. Approved by two reviewers and passed CI checks. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update adding labels for the overlay step. Fixes reference issues for applications excluding the overlay explanation page. Unblocks CRAFT-3043. |
Update history
No update history recorded yet.
Related work
-
Caused By:
canonical/craft-parts#765
(confidence 100%)
Added the overlay-explanation reference that required explicit labels.
-
Related To:
canonical/snapcraft#4948
(confidence 98%)
Downstream change demonstrated the failure when the explanation page was excluded.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #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. | |
| #1453 docs: fix headings in 'Overlay step' explanation | craft-parts | merged | Merged PR #1453 as commit b6d6d35b, fixing heading levels in docs/common/craft-parts/explanation/overlays.rst so top-level headings no longer leak into the explanation category ToC. | |
| #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. | |
| #137 many: add overlay step (CRAFT-84) | craft-parts | merged | Merged craft-parts#137 as commit 1a813210, adding the overlay lifecycle step and subsystem support for package installation and filesystem mutations. | |
| #4948 docs: exclude overlay step, bump craft-parts to 1.34.0 | snapcraft | merged | Merged in canonical/snapcraft#4948, fixing the docs build by excluding overlay-step docs and bumping craft-parts to 1.34.0 (f57f7e0c0, de13316cb). | |
| #135 executor: add overlay step handling (CRAFT-86) | craft-parts | merged | Merged PR #135 via b7527d5b, adding overlay-step execution handling that mounts the overlay stack during builds. |