← Back to issue list

docs: add `charm-user` in the charmcraft.yaml file reference

View original Github issue

Metadata

Project
charmcraft
Number
#2195
Type
pull request
State
merged
Author
tonyandrewmeyer
Labels
Created
Updated
Closed

Current evaluation

Merged documentation update adding the charm-user field to the charmcraft.yaml reference. The contributor also added the field to a basic smoke test for e2e coverage. Commits will be squashed upon merge.

Suggested action:

No scores available.

Issue body

The `charm-user` field is documented in the metadata.yaml file reference, but is missing from the charmcraft.yaml file reference, even though it does work there. This PR adds it to that reference. As the docs currently are, it gives the incorrect impression that you cannot use the combined charmcraft.yaml file to specify `charm-user`, and must have separate metadata, actions, and config files.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged documentation update adding the charm-user field to the charmcraft.yaml reference. The contributor also added the field to a basic smoke test for e2e coverage. Commits will be squashed upon merge.
qwen3.6-35b-a3b-mtp-q6 Merged documentation update adding the charm-user field to the charmcraft.yaml reference and a basic smoke test. Commits will be squashed on merge.
qwen3.6-35b-a3b-mtp-q6 Merged documentation update adding the charm-user field to the charmcraft.yaml reference. A basic smoke test was also updated to include the field. Commits were squashed upon merge.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#1850 feat(metadata): add charm-user to charmcraft.yaml charmcraft merged Merged a feature adding charm-user to charmcraft.yaml, resolving issue #1806. Approved by two reviewers and passing CI, the update modifies five files with 38 additions and 2 deletions.
74%
#471 config: add charm part to documentation (CRAFT-356) charmcraft merged Merged changes adding charm configuration documentation to the configuration schema. Approved by two reviewers with zero unresolved comments. Updated two files with 15 additions and one deletion. Resolves CRAFT-356.
74%
#242 Add init documentation for a gentle introduction to the charm operator charmcraft merged Merged PR adding starter docs to charmcraft init. Reviewer requested moving content to a Charmhub discourse wiki and linking it. Contributor adapted the change, and the PR was merged with the external link integrated.
70%
#2240 docs: update charm definition in security doc charmcraft merged Merged documentation update revising the charm definition in the security guide. Incorporated feedback from a prior discussion, approved by two reviewers, passed CI checks, and successfully merged with minimal line changes.
70%