← 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

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.

Suggested action: keep open

Reason: The issue is a valid documentation gap (label Type: Documentation) but has zero comments and no maintainer acknowledgement, so it is untriaged. The referenced part_properties page now redirects to rockcraft.yaml, which includes the craft-parts overlay_parameters fragment documenting overlay-packages, so a maintainer should verify the current docs before closing.

Impact: 25 Quick Win: 21.25 Staleness: 55 Complexity: 15 Confidence: 70 Support Request: 10

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
qwen/qwen3.8-27b
Impact: 25
Quick Win: 21.25
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.
qwen3.6-35b-a3b-mtp-q6
Staleness: 88
Complexity: 10
Confidence: 75
Support Request: 10
close stale Missing documentation for the overlay-packages field in Rockcraft part properties. Requested to clarify usage for installing packages. Open with zero comments and 186 days of inactivity. Needs documentation update.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#486 overlay-packages is not documented in rockcraft.yaml reference rockcraft 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.
88%
#680 doc: missing overlay info in rockcraft.yaml reference rockcraft closed 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.
80%
#436 feat(docs): add definition for overlay_step in the docs rockcraft merged 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.
74%
#297 docs: rockcraft.yaml reference rockcraft closed Closed without fixing. Maintainer directed users to craft-parts documentation for the organize field, noting plans to integrate those docs into the rockcraft reference later.
72%