docs(pack): refer to inline charmcraft.yaml metadata in pack help
Metadata
Current evaluation
Merged documentation update to pack help that replaces legacy metadata.yaml references with modern inline charmcraft.yaml metadata guidance. Approved by two reviewers and passed CI checks.
Suggested action: —
No scores available.
Issue body
The `pack --help` overview instructs users to ensure a valid `metadata.yaml` exists. That is the legacy split-file format; modern charms put metadata inline in `charmcraft.yaml`, so the stale guidance sends readers looking for a file that should not exist.
---
- [x] I've followed the [contribution guidelines](https://github.com/canonical/charmcraft/blob/main/CONTRIBUTING.md).
- [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/).
- [x] I've successfully run `make lint && make test`.
- [x] I've added or updated any relevant documentation.
- [x] In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing.
- [x] I've updated the relevant release notes.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update to pack help that replaces legacy metadata.yaml references with modern inline charmcraft.yaml metadata guidance. Approved by two reviewers and passed CI checks. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
25
Complexity:
5
Confidence:
95
|
needs review | Updates pack CLI help text to reference inline charmcraft.yaml metadata instead of the legacy metadata.yaml format. Awaiting maintainer review. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #817 docs(README): Replace obsoleted build command | charmcraft | merged | Merged an external contribution updating the README to replace the obsolete charmcraft build command with pack, reflecting the transition to pack.py in version 2.0.0. Approved by one reviewer, passed CI, and modified one file. | |
| #821 5.5.0 changes pack semantics if the project file has different metadata | craft-application | open | Charmcraft pack skips repacking when only charmcraft.yaml metadata (e.g. summary, config, platforms) changes, leaving a stale .charm. Triaged and moved to craft-application; workaround is clean. Conditional repacking support added in #1111. | |
| #2351 fix(templates): update out-of-date parts in template README files | charmcraft | merged | Merged update to kubernetes and machine template README files. Replaced metadata.yaml with charmcraft.yaml, updated package naming, and fixed documentation links. Approved by three reviewers and merged. | |
| #471 config: add charm part to documentation (CRAFT-356) | charmcraft | merged | Merged changes adding charm configuration documentation to the configuration schema. Approved by two reviewers with zero unresolved comments. Updated two files with 15 additions and one deletion. Resolves CRAFT-356. |