Update init templates to use a single current Charmcraft docs link
Metadata
Current evaluation
Rejected and closed without merging. A maintainer noted the template cleanup contradicted previous requests, as it removed legacy documentation comments instead of consolidating them as intended.
Suggested action: —
No scores available.
Issue body
The generated `charmcraft.yaml` files still carried multiple inline documentation links, including older or redundant references. This change consolidates template output around a single current Charmcraft documentation URL.
- **Template cleanup**
- Updates the machine and Kubernetes `init` templates to keep one canonical `charmcraft.yaml` reference at the top of the file.
- Removes section-local documentation comments for platforms, config, containers, resources, and Juju configuration guidance.
- **Generated output contract**
- Tightens `init` integration coverage so generated `charmcraft.yaml` files:
- include exactly one canonical Charmcraft docs link,
- place it at the top of the file,
- omit the removed legacy documentation comment patterns.
- **Resulting template shape**
```yaml
# This file configures Charmcraft.
# See https://documentation.ubuntu.com/charmcraft/stable/reference/files/charmcraft-yaml-file/ for guidance.
type: charm
name: my-charm
```
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Rejected and closed without merging. A maintainer noted the template cleanup contradicted previous requests, as it removed legacy documentation comments instead of consolidating them as intended. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Closed without merging. The init template update consolidating Charmcraft documentation links was rejected after a maintainer noted it contradicted prior feedback. Changes were abandoned. |
Update history
| Date | Change |
|---|---|
| created |
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #828 Automatically update template operator based on latest charmcraft init | charmcraft | closed | Rejected and closed. Maintainer declined automatic template updates due to upcoming charmcraft init profiles, potential divergence, and policy against cross-repo automation. May revisit once profiles are widely adopted. |