Update command docs for the unification of charmcraft.yaml
Metadata
Current evaluation
Command help still uses metadata.yaml for list-lib while lifecycle help uses charmcraft.yaml; later documentation cleanups were partial, leaving the unification task unresolved.
Suggested action: keep open
Reason: Current list-lib command help in charmcraft/application/commands/store.py still tells users that the name comes from metadata.yaml, and its error message repeats that filename, while lifecycle help already refers to charmcraft.yaml. Commit b5334d9b (#2705) fixed pack help only, and #2154 was a broader terminology cleanup, so the original documentation task remains valid but is not demonstrably complete.
Evaluated by: mr-cal-bot
Issue body
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha |
Impact:
35
Quick Win:
16
Complexity:
40
Confidence:
84
Actionability:
78
|
keep open | Command help still uses metadata.yaml for list-lib while lifecycle help uses charmcraft.yaml; later documentation cleanups were partial, leaving the unification task unresolved. | |
| ~deepseek/deepseek-pro-latest |
Impact:
35
Quick Win:
13
Complexity:
30
Confidence:
60
Actionability:
55
|
keep open | Maintainer task to sweep command docs for legacy metadata.yaml/config.yaml references and update them to charmcraft.yaml; list-lib help still references metadata.yaml, task remains open. | |
| qwen/qwen3.6-35b-a3b |
Impact:
30
Quick Win:
14
Complexity:
20
Confidence:
70
Actionability:
60
|
keep open | Update command documentation to reference charmcraft.yaml instead of metadata.yaml as part of the configuration unification effort. Open for 875 days with no maintainer response. | |
| qwen/qwen3.8-27b |
Impact:
35
Quick Win:
26
Staleness:
55
Complexity:
25
Confidence:
72
Support Request:
0
|
keep open | Doc task to update command help text referencing metadata.yaml to charmcraft.yaml. Partially addressed in code (some commands updated, CreateLibCommand and ListLibCommand still say metadata.yaml). No labels, no maintainer response beyond Jira bot, last activity 381 days ago. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
85
Complexity:
10
Confidence:
85
Support Request:
0
|
needs triage | Update command documentation to reference charmcraft.yaml instead of metadata.yaml. Unlabelled, unassigned, and inactive for over two years, awaiting maintainer assessment. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
85
Complexity:
10
Confidence:
75
Support Request:
0
|
needs triage | Documentation update task to replace metadata.yaml references with charmcraft.yaml in command docs. Unlabelled, inactive for over a year, awaiting maintainer triage. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
85
Complexity:
10
Confidence:
80
Support Request:
0
|
needs triage | Documentation task to replace metadata.yaml references with charmcraft.yaml across command docs. Unlabelled, inactive for over a year, awaiting maintainer triage. |
Update history
No update history recorded yet.
Related work
-
Related To:
charmcraft#2705
(confidence 95%)
Commit b5334d9b updated pack help to refer to inline charmcraft.yaml metadata, but does not cover the stale list-lib wording.
-
Related To:
charmcraft#2154
(confidence 88%)
Merged commit a6ccb3d4 cleaned up charmcraft.yaml and recipe terminology across documentation, but does not establish that metadata.yaml command references were removed.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2795 docs: improve `charmcraft clean` command documentation | charmcraft | closed | Closed unmerged; maintainer @lengau rejected the proposed charmcraft clean documentation as subpar, and no documentation commit or replacement PR landed. | |
| #2213 Change templates to link to current documentation | charmcraft | open | Maintainer task to update charmcraft.yaml templates to link to modern documentation instead of outdated juju.is pages and remove repeated/outdated info; unlabelled and unassessed. | |
| #1434 Improve Documentation for 'charmcraft help clean' Command | charmcraft | open | Documentation request for `charmcraft clean` help text; current overview is brief and issue lacks specific gaps. Related PR #2795 was rejected as subpar; no maintainer triage on issue. |