pack README.md and require README.md in uploaded bundle
Metadata
Current evaluation
Fixed by merged PR #298: charmcraft pack now requires/includes README.md in bundles, satisfying Juju's validation (commit 185866f7, merge 65d735b0).
Resolution: closed resolved
Reason: Maintainer facundobatista committed to making README.md mandatory, and PR #298 ("Mandatorily include a README.md file when packing bundles") was merged (commit 185866f7, merge 65d735b0), closing the issue.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Juju will deploy a local packed bundle without an README.md file. However it will not deploy a bundle without a README.md file from charm hub.
Please require README.md to upload a bundle.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Fixed by merged PR #298: charmcraft pack now requires/includes README.md in bundles, satisfying Juju's validation (commit 185866f7, merge 65d735b0). | |
| stealth/space-bunny-alpha | — | closed resolved | Fixed by merged PR #298, which made README.md mandatory when packing bundles (commit 185866f7; merge 65d735b0). | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Fixed by making README.md mandatory for bundle packing and uploads. Charmcraft now automatically includes it in the bundle zip and enforces its presence during validation, eliminating the need for manual prime configuration. | |
| qwen/qwen3.6-35b-a3b | — | — | README.md is now automatically included and mandatory in packed bundles. The request was accepted and implemented, removing the need for manual prime configuration and ensuring Juju deployment validation succeeds. | |
| qwen/qwen3.6-35b-a3b | — | — | The request was accepted and implemented to make README.md mandatory and include it by default in packed bundles, resolving deployment failures. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Fixed by making README.md mandatory in charmcraft bundle packs. The tool now automatically includes it by default, resolving Charm Hub deployment failures caused by missing documentation. |
Update history
No update history recorded yet.
Related work
-
Likely Fixed By:
canonical/charmcraft#298
(confidence 97%)
Merged PR that made README.md mandatory when packing bundles.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #298 Mandatorily include a README.md file when packing bundles. | charmcraft | merged | README.md is now mandatory when packing bundles, merged in PR #298 via commit 185866f7 (merge 65d735b0). | |
| #1341 [JUJU-4554] Update the README to simplify and better align with docs | charmcraft | merged | Docs-only PR merged as commit 647a605c (#1341): rewrote Charmcraft's README (+62/-118) to a shorter intro placing Charmcraft in the Juju/Charm SDK ecosystem and linking to Charm SDK docs instead of Multipass install steps. |