Add `config` example to templates
Metadata
Current evaluation
Added commented sample config sections to all Charmcraft init templates, fixing the Kubernetes and machine profile inconsistency. Merged in PR #1476 as commit 67f314a1.
Resolution: closed resolved
Reason: PR #1476 was merged and commit 67f314a1 added example config sections across the templates, resolving the reported inconsistency.
Evaluated by: mr-cal-bot
No scores available.
Issue body
### Bug Description
Template created by `charmcraft init --profile simple` contains a `config.yaml` file. Other profiles - `kubernetes` and `machine` don't contain this file although it is equally relevant.
cc @tmihoc
### To Reproduce
Run
```
$ mkdir simple
$ charmcraft init --profile simple
$ mkdir ../kubernetes
$ cd ../kubernetes
$ charmcraft init --profile kubernetes
$ ls
CONTRIBUTING.md README.md metadata.yaml requirements.txt tests
LICENSE charmcraft.yaml pyproject.toml src tox.ini
$ ls ../simple
CONTRIBUTING.md charmcraft.yaml pyproject.toml tests
LICENSE config.yaml requirements.txt tox.ini
README.md metadata.yaml src
```
### Environment
Multipass vm based on `charm-dev` profile:
```
$ charmcraft version
2.4.1
```
### charmcraft.yaml
```shell
.
```
### Relevant log output
```shell
No relevant logs
```
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Added commented sample config sections to all Charmcraft init templates, fixing the Kubernetes and machine profile inconsistency. Merged in PR #1476 as commit 67f314a1. | |
| stealth/space-bunny-alpha | — | closed resolved | Added commented sample config sections to all Charmcraft templates, resolving the profile inconsistency. Fixed by merged PR #1476 in commit 67f314a1. | |
| qwen/qwen3.6-35b-a3b | — | — | Fixed via PR #1476. Kubernetes and machine profile templates now include a commented-out config section in charmcraft.yaml, replacing the standalone config.yaml file to align with the unified configuration approach. | |
| qwen/qwen3.8-27b |
Impact:
30
Quick Win:
26
Staleness:
55
Complexity:
15
Confidence:
92
Support Request:
5
|
close stale | Request to add a config example section to kubernetes and machine init templates. Fixed by PR #1476 which added example config sections to all templates; both templates now include a log-level config option. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
70
Complexity:
15
Confidence:
75
Support Request:
0
|
keep open | Request to add config examples to kubernetes and machine charm templates. Maintainer updated scope to include commented config in charmcraft.yaml and kept it open. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
75
Complexity:
20
Confidence:
85
Support Request:
0
|
keep open | Contributor requested adding config examples to kubernetes and machine templates. Maintainer updated scope to include a commented-out config section in charmcraft.yaml and kept it open. Awaiting implementation. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
75
Complexity:
15
Confidence:
80
Support Request:
0
|
keep open | Request to add config examples to kubernetes and machine charm templates. Maintainer updated scope to include commented config in charmcraft.yaml. Currently open but inactive for over 10 months. |
Update history
| Date | Change |
|---|---|
| closed |
Related work
-
Likely Fixed By:
canonical/charmcraft#1476
(confidence 100%)
Merged PR whose commit 67f314a1 added example config sections to all init templates.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1476 fix(templates): put example config sections on all templates | charmcraft | merged | Merged PR #1476 (67f314a1), adding example config sections to all charm templates for consistent configuration examples. | |
| #2365 Add test configuration templates for charmcraft | charmcraft | closed | Test init profiles delivered by merged PR #2401 (commit a7334d49), adding test-machine and test-kubernetes templates for `charmcraft init`; shipped in Charmcraft 4.0. | |
| #859 Added a kubernetes profile to init command (CRAFT-1318). | charmcraft | merged | Merged in canonical/charmcraft#859 (451c399a), adding the Kubernetes init profile and fixing the simple template for CRAFT-1318. |