← 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

Rockcraft’s rockcraft.yaml reference does not explain how global fields populate OCI labels/annotations and internal ROCK metadata; the documentation task remains open with a contributor requesting assignment.

Suggested action: keep open

Reason: The maintainer-authored request is valid and categorized as Type: Documentation. The implementation in generate_metadata() maps version, title, created, description, license, and non-bare base digest to OCI annotations, while set_annotations() also configures image labels, but the current generated reference does not explain these mappings. The contributor’s request to be assigned indicates ongoing interest, so the issue should remain open rather than be closed as stale or resolved.

Evaluated by: mr-cal-bot

Impact: 30 Quick Win: 14 Complexity: 42 Confidence: 93 Actionability: 78

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
stealth/space-bunny-alpha
Impact: 30
Quick Win: 14
Complexity: 42
Confidence: 93
Actionability: 78
keep open Rockcraft’s rockcraft.yaml reference does not explain how global fields populate OCI labels/annotations and internal ROCK metadata; the documentation task remains open with a contributor requesting assignment.
stealth/space-bunny-alpha
Impact: 35
Quick Win: 17
Complexity: 40
Confidence: 91
Actionability: 82
keep open Documentation should explain how top-level rockcraft.yaml fields map to OCI labels, annotations, and /.rock/metadata.yaml; it remains open, with a volunteer awaiting assignment.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 17
Complexity: 20
Confidence: 70
Actionability: 70
keep open Documentation issue requesting clarification of how global rockcraft.yaml fields map to OCI metadata (labels, annotations) in the final ROCK. A contributor has volunteered to work on it.
qwen/qwen3.8-27b
Impact: 35
Quick Win: 24
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.

Update history

No update history recorded yet.

Related work

  • Related To: rockcraft#289 (confidence 90%)

    The merged reference-expansion PR reorganized and expanded rockcraft.yaml documentation, but the current reference still lacks the explicit OCI metadata mapping requested here.

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

    The earlier global-metadata PR was closed unmerged after being deferred, so it provides related context but no resolution.

Related issues

Issue Project State Summary Similarity
#34 project: expand global metadata properties in rockcraft.yaml rockcraft closed Closed unmerged on 2022-06-30; the proposed global metadata properties were deferred because they were not yet on the roadmap.
70%