fix(templates): update out-of-date parts in template README files
Metadata
Current evaluation
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.
Suggested action: —
No scores available.
Issue body
Inspired by https://github.com/canonical/charmcraft/pull/2350, this PR makes some fixes in the template README files for the `kubernetes` and `machine` profiles.
Fixes:
- Talk about `charmcraft.yaml` instead of `metadata.yaml`
- Use the (dynamic) charm name for the package name instead of `operator-template`
- Replace links to https://juju.is/docs/sdk by https://documentation.ubuntu.com/juju/3.6/howto/manage-charms/
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged update to kubernetes and machine template READMEs. Replaced metadata.yaml with charmcraft.yaml, updated package name placeholders, and redirected Juju SDK links to current Ubuntu documentation. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged changes update kubernetes and machine template README files. Replaces metadata.yaml with charmcraft.yaml, applies dynamic charm naming, and refreshes Juju documentation links. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2154 docs: replace occurrences of "charmcraft.yaml" and "recipe" | charmcraft | merged | Merged documentation update replacing charmcraft.yaml and recipe with project or project file across 23 files. Approved by two reviewers after minor clarity feedback. Changes span +155/-159 lines. | |
| #1468 replaced metadata.yaml with charmcraft.yaml in integration test templates | charmcraft | closed | Abandoned due to unresolved CLA signature issues. The maintainer confirmed the template update was valid and created a new PR to apply the changes and resolve the check. | |
| #1199 docs: update README according to template | craft-parts | merged | Merged after two approvals and passing CI. Updates the README to align with a standard template, heavily inspired by Craft Application, modifying one file with 40 additions and 11 deletions. | |
| #283 Smoother and safer template project from init command. | charmcraft | merged | Merged updates to charmcraft init that prevent publishing charms with leftover TEMPLATE-TODO markers. Validation was moved from build to upload per reviewer feedback. Fixes #237, #238, #243, and #247. | |
| #2213 Change templates to link to current documentation | charmcraft | open | Charmcraft templates should link charmcraft.yaml to modern docs instead of outdated juju.is pages. No comments or labels; recent template commits show active maintenance, so it needs triage. | |
| #2705 docs(pack): refer to inline charmcraft.yaml metadata in pack help | charmcraft | merged | 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. | |
| #1666 fix: only keep metadata.yaml for reactive charms | charmcraft | merged | Merged to fix issue #1654 by restricting metadata.yaml retention to reactive charms only. Approved by two reviewers, passed CI, and modified six files (+101/-5). | |
| #2753 docs: update urls and doc string in kubernetes and machine profiles | charmcraft | merged | Merged after two approvals. Updates URLs and docstrings in Kubernetes and machine profiles, resolving issue #2752. CI checks passed and changes were integrated across six files with a minimal diff. |