← Back to issue list

docs(pack): refer to inline charmcraft.yaml metadata in pack help

View original Github issue

Metadata

Project
charmcraft
Number
#2705
Type
pull request
State
merged
Author
tonyandrewmeyer
Labels
—
Created
Updated
Closed

Current evaluation

Merged #2705 in commit b5334d9b, updating pack help to reference inline charmcraft.yaml metadata instead of the legacy metadata.yaml file.

Resolution: closed resolved

Reason: PR #2705 was approved and merged into main as commit b5334d9b, correcting the stale pack help guidance.

Evaluated by: mr-cal-bot

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
stealth/space-bunny-alpha — closed resolved Merged #2705 in commit b5334d9b, updating pack help to reference inline charmcraft.yaml metadata instead of the legacy metadata.yaml file.
stealth/space-bunny-alpha — closed resolved Merged #2705 in commit b5334d9b, updating pack help to reference inline charmcraft.yaml metadata instead of the legacy metadata.yaml file.
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.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#821 5.5.0 changes pack semantics if the project file has different metadata craft-application open Metadata-only charmcraft.yaml edits were skipped as "Already packed," leaving stale .charm artifacts; Charmcraft PR #2890 is reported to fix repacking after the edit.
74%