← Back to issue list

clarify the impact of the global rockcraft.yaml fields in the final ROCK

View original Github issue

Metadata

Project
rockcraft
Number
#425
Type
issue
State
open
Author
cjdcordeiro
Labels
Type: Documentation
Created
Updated
Closed
—

Current evaluation

Docs gap: rockcraft.yaml reference does not document that global metadata fields (name, title, summary, description, version, license) implicitly become OCI labels/annotations in the final rock. Open ~3 years; a contributor asked to be assigned on 2026-03-17.

Suggested action: keep open

Reason: The gap is still real: generate_metadata() in rockcraft/models/project.py (lines 405-443) maps version/title/summary/description/license/base to org.opencontainers.image.* annotations, but the refreshed docs/reference/rockcraft-yaml.rst (kitbash-field directives) contains no mention of this implicit OCI behavior. A contributor (gcomneno) requested assignment on 2026-03-17, so it is not stale and should stay open pending maintainer acknowledgement.

Impact: 35 Quick Win: 24.5 Staleness: 45 Complexity: 30 Confidence: 75 Support Request: 0

Issue body

E.g. https://github.com/canonical/rockcraft/blob/945051ff5a658bc1c3173a114b56fe535ee0fb45/docs/reference/rockcraft.yaml.rst?plain=1#L66 Such metadata fields will make Rockcraft create certain OCI metadata fields (like labels and annotations), but the docs are explicit about that. We should cover those details in the docs, for all yaml fields that have some sort of implicit behaviour.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 35
Quick Win: 24.5
Staleness: 45
Complexity: 30
Confidence: 75
Support Request: 0
keep open Docs gap: rockcraft.yaml reference does not document that global metadata fields (name, title, summary, description, version, license) implicitly become OCI labels/annotations in the final rock. Open ~3 years; a contributor asked to be assigned on 2026-03-17.
qwen/qwen3.6-35b-a3b
Staleness: 55
Complexity: 15
Confidence: 90
Support Request: 5
keep open Documentation request to clarify how global rockcraft.yaml fields map to OCI metadata labels and annotations. Currently awaiting assignment after a contributor volunteered four months ago.
qwen3.6-35b-a3b-mtp-q6
Staleness: 55
Complexity: 20
Confidence: 85
Support Request: 0
needs triage Documentation gap regarding implicit OCI metadata generation from global rockcraft.yaml fields. A volunteer recently requested assignment, but the task remains untriaged and unassigned by maintainers.
qwen3.6-35b-a3b-mtp-q6
Staleness: 40
Complexity: 25
Confidence: 85
Support Request: 5
keep open Documentation improvement to clarify how global rockcraft.yaml fields map to OCI metadata. A contributor recently requested assignment to implement the changes.
qwen3.6-35b-a3b-mtp-q6
Staleness: 45
Complexity: 15
Confidence: 85
Support Request: 5
keep open Document how global rockcraft.yaml fields map to OCI labels and annotations in the final ROCK image. Open and awaiting assignment after a contributor requested to work on it.

Update history

No update history recorded yet.

Related work

  • Related To: rockcraft#34 (confidence 60%)

    Earlier PR proposing expanded global metadata properties in rockcraft.yaml; closed without merging, but contextually related to the same metadata fields this doc issue covers.

Related issues

Issue Project State Summary Similarity
#34 project: expand global metadata properties in rockcraft.yaml rockcraft closed Abandoned without merging. The proposed rockcraft.yaml metadata properties were closed because they are not on the current development roadmap. Feedback on additional fields was noted but deferred pending future planning.
75%