`charmcraft init`: issues with --profile docs, default profile, and default charm.py links
Metadata
Current evaluation
The outdated charm.py link was updated to official documentation via PR #1158, closing the issue. Profile documentation improvements were acknowledged but not implemented.
Suggested action: —
No scores available.
Issue body
### Bug Description
I wanted to initialize a machine charm. I looked up the `charmcraft init` help: https://juju.is/docs/sdk/charmcraft-init . (Issue 1) It mentioned the `--profile` option but not what arguments it could take (other than to say it defaults to `simple`, which was also not defined). I gave up and just ran the command without selecting a profile. Then I noticed (Issue 2) the charm it had initialized by default was a Kubernetes charm. Also, (issue 3) the comment at the top of the `charm.py` file linked to quick-start guide (https://discourse.charmhub.io/t/4208) that is not published in the docs and which doesn't really make much sense (e.g., it contains instructions on how to install `charmcraft` and how to run `charmcraft init` but, if you've come to this page from the charm.py produced by `charmcraft init`, then you already know how to do all that).
I think we should document all the possible arguments for `--profile`, not apply any default to `charmcraft init` (prompt the user to choose), and link only to official docs.
### To Reproduce
Issue 1: Run `charmcraft init --help` or visit https://juju.is/docs/sdk/charmcraft-init .
Issue 2: Run `charmcraft init`.
Issue 3: Inspect the contents of the `charm.py` file generated by `charmcraft init`.
### Environment
Not applicable.
### charmcraft.yaml
```shell
Not relevant.
```
### Relevant log output
```shell
Not relevant.
```
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen3.6-35b-a3b-mtp-q6 | — | — | The outdated charm.py link was updated to official documentation via PR #1158, closing the issue. Profile documentation improvements were acknowledged but not implemented. | |
| qwen/qwen3.6-35b-a3b | — | — | The outdated charm.py link was updated to official documentation via merged PR #1158. Requests for detailed --profile documentation and interactive prompting were not addressed. | |
| qwen/qwen3.6-35b-a3b | — | — | The outdated charm.py link was updated to official documentation via PR #1158. Remaining issues regarding --profile documentation and default profile prompting were not addressed before closure. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Partially resolved via PR #1158, which updated the charm.py link to official documentation. Requests to document --profile options and remove the default profile were abandoned. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Resolved the outdated charm.py link via PR #1158. The issue closed after this merge, while requested documentation for --profile and default behavior remain unaddressed. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #966 `charmcraft init --help` doesn't list the available profiles | charmcraft | closed | Fixed in pull request #2311. The charmcraft init help output now correctly lists all available profiles, resolving the usability concern. | |
| #1139 `charmcraft init --profile machine` doesn't produce `config.yaml` | charmcraft | closed | Fixed in PR #1149. The machine charm init template and output were updated to remove config.yaml and metadata.yaml from the default files, now directing users to only edit charmcraft.yaml. |