overlay-packages is not documented in rockcraft.yaml reference
Metadata
Current evaluation
Documentation gap for overlay-packages in rockcraft.yaml part properties; maintainer confirmed it originates from craft-parts docs.
Suggested action: keep open
Reason: A maintainer acknowledged the missing documentation and identified craft-parts as the upstream source for the overlay-packages property. The issue is valid and actionable, requiring a documentation update in the upstream project before it can be resolved here.
Evaluated by: mr-cal-bot
Impact:
30
Quick Win:
22
Complexity:
10
Confidence:
85
Actionability:
80
Issue body
### Request type
Fix
### What needs to get done
overlay-packages in a part appears to be commonly used - eg. here: https://github.com/canonical/ceph-containers/blob/234fd0c1d9d5770fb6497750c0504a4ec501b718/rockcraft.yaml#L33
However, this is not referenced in the reference documentation for rockcraft.yaml: https://canonical-rockcraft.readthedocs-hosted.com/en/latest/reference/part_properties/#part-properties
With more searching around, I see there are things like the overlay step which has overlay-packages, overlay-script, etc. referenced: https://canonical-rockcraft.readthedocs-hosted.com/en/latest/explanation/overlay-step/#overlay-parameters , but this is not in the reference docs, and thus difficult to find.
### Documentation location
_No response_
### Additional information
_No response_
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b |
Impact:
30
Quick Win:
22
Complexity:
10
Confidence:
85
Actionability:
80
|
keep open | Documentation gap for overlay-packages in rockcraft.yaml part properties; maintainer confirmed it originates from craft-parts docs. | |
| stealth/space-bunny-alpha |
Impact:
25
Quick Win:
23
Complexity:
5
Confidence:
98
Actionability:
98
|
close resolved | Documentation gap resolved: the current rockcraft.yaml part-key reference documents overlay-packages as overlay_packages. | |
| qwen/qwen3.6-35b-a3b |
Impact:
30
Quick Win:
19
Complexity:
20
Confidence:
85
Actionability:
80
|
keep open | Documentation gap: overlay-packages is missing from the rockcraft.yaml reference docs but used in parts. Maintainer confirmed the fix belongs in upstream craft-parts docs. | |
| qwen/qwen3.8-27b |
Impact:
30
Quick Win:
24
Staleness:
55
Complexity:
20
Confidence:
70
Support Request:
5
|
keep open | overlay-packages (and other overlay part properties) are missing from the rockcraft.yaml reference docs; maintainer noted the fix belongs in craft-parts' part_properties.rst. Still open with no follow-up. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
70
Complexity:
15
Confidence:
90
Support Request:
0
|
keep open | Documentation gap: overlay-packages missing from rockcraft.yaml reference. Acknowledged by maintainer, points to upstream craft-parts docs for resolution. Currently awaiting upstream update. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
60
Complexity:
15
Confidence:
85
Support Request:
0
|
keep open | Missing reference documentation for overlay-packages in rockcraft.yaml parts. Acknowledged by a maintainer who noted the fix is needed upstream in craft-parts. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
75
Complexity:
10
Confidence:
90
Support Request:
0
|
keep open | Documentation gap: overlay-packages part property is missing from rockcraft.yaml reference docs. Maintainer pointed to upstream craft-parts as the source, but no fix has been implemented in over 6 months. |
Update history
No update history recorded yet.
Related work
-
Related To:
rockcraft#512
(confidence 80%)
Tracks the same documentation gap for overlay-packages.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #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. |