← Back to issue list

Document `overlay-packages`

View original Github issue

Metadata

Project
rockcraft
Number
#512
Type
issue
State
open
Author
alnvdl-work
Labels
Type: Documentation
Created
Updated
Closed
—

Current evaluation

`overlay-packages` is now included in the unified rockcraft.yaml reference, and the former part-properties URL redirects to the new reference.

Suggested action: close resolved

Reason: Commit fd28a343 (PR #1041) generated the rockcraft.yaml reference and added `PartSpec overlay_packages`. The current `docs/reference/rockcraft-yaml.rst` declares that field, while `docs/redirects.txt` redirects the original `reference/part_properties` path to the unified reference.

Evaluated by: mr-cal-bot

Impact: 28 Quick Win: 23 Complexity: 10 Confidence: 96 Actionability: 90

Issue body

### Request type Fix ### What needs to get done The documentation for `overlay-packages` is missing from https://canonical-rockcraft.readthedocs-hosted.com/en/latest/reference/part_properties/#. I'm using this field as recommended [here](https://matrix.to/#/!NPPCseDHKRvSBMUEXN:ubuntu.com/$w1_MHdr5oAYR5GEp3QbfLVgNUUJ2LmKLf3ieaMwdfZQ?via=ubuntu.com&via=matrix.org) to install `ca-certificates`. ### Documentation location https://canonical-rockcraft.readthedocs-hosted.com/en/latest/reference/part_properties/ ### Additional information _No response_

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 28
Quick Win: 23
Complexity: 10
Confidence: 96
Actionability: 90
close resolved `overlay-packages` is now included in the unified rockcraft.yaml reference, and the former part-properties URL redirects to the new reference.
stealth/space-bunny-alpha
Impact: 25
Quick Win: 20
Complexity: 15
Confidence: 98
Actionability: 95
close resolved `overlay-packages` is now documented in the Rockcraft part-key reference and explained as installing packages before the build step.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 14
Complexity: 20
Confidence: 60
Actionability: 60
keep open Documentation for the overlay-packages part property is missing from the rendered rockcraft docs; the field is defined in craft-parts source but may not be rendering correctly.
qwen/qwen3.8-27b
Impact: 25
Quick Win: 21
Staleness: 55
Complexity: 15
Confidence: 70
Support Request: 10
keep open Docs gap: overlay-packages missing from Rockcraft part_properties reference. The referenced page now redirects to rockcraft.yaml, which documents overlay parameters via an included craft-parts fragment, so the gap is likely resolved. No maintainer activity in 263 days.
qwen/qwen3.6-35b-a3b
Staleness: 85
Complexity: 15
Confidence: 80
Support Request: 10
close stale Request to document the overlay-packages field in Rockcraft part properties. Issue lacks maintainer comments, has been inactive for over seven months, and remains unaddressed.
qwen3.6-35b-a3b-mtp-q6
Staleness: 80
Complexity: 10
Confidence: 90
Support Request: 0
needs triage Missing documentation for the overlay-packages field in Rockcraft part properties. The request has been open for over two years with no maintainer response or further discussion.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 15
Confidence: 80
Support Request: 10
needs triage Request to add missing documentation for the overlay-packages part property in Rockcraft. Currently unassessed by maintainers with zero comments after over two years.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: rockcraft#1041 (confidence 98%)

    PR #1041 generated the reference containing overlay-packages and replaced the former standalone part-properties page.

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.
81%
#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.
78%
#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.
70%