← Back to issue list

Update command docs for the unification of charmcraft.yaml

View original Github issue

Metadata

Project
charmcraft
Number
#1668
Type
issue
State
open
Author
lengau
Labels
Created
Updated
Closed

Current evaluation

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.

Suggested action: keep open

Reason: Filed by maintainer lengau and partially addressed in the codebase (e.g. fetch-lib and fetch-lib-libs now reference charmcraft.yaml, but CreateLibCommand overview at store.py:1275 and ListLibCommand help at store.py:1815/1828 still say metadata.yaml). The remaining references are still inaccurate since the project file is now charmcraft.yaml, so the issue remains valid and actionable.

Impact: 35 Quick Win: 26.25 Staleness: 55 Complexity: 25 Confidence: 72 Support Request: 0

Issue body

### What needs to get done Find references in command documentation that reference metadata.yaml, etc. and update them for charmcraft.yaml ### Why it needs to get done We're unifying everything around charmcraft.yaml

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 35
Quick Win: 26.25
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.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 10
Confidence: 80
Support Request: 5
close stale Update command documentation to replace metadata.yaml references with charmcraft.yaml following the config unification. Stale for over eight months. Internal Jira ticket CRAFT-2855 created. Needs triage and assignment to proceed.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: charmcraft#2705 (confidence 45%)

    Commit b5334d9b 'docs: refer to inline charmcraft.yaml metadata in pack help' updates pack command help to reference charmcraft.yaml, which is the same class of change this issue requests, though it may only cover one command.

Related issues

Issue Project State Summary Similarity
#295 Update charm library template for correct command to publish or update libraries charmcraft merged Merged a fix to update the charm library template with the correct command, replacing the non-existent charmcraft push-lib. Approved by two reviewers with minimal changes.
70%