← Back to issue list

Add yaml formatting feature in charmcraft status

View original Github issue

Metadata

Project
charmcraft
Number
#940
Type
issue
State
closed
Author
rahulsinghcanonical
Labels
—
Created
Updated
Closed

Current evaluation

Proposal to add YAML output to `charmcraft status --format` was declined; maintainer facundobatista noted the flag exists for machine consumption. Author rahulsinghcanonical agreed and closed it himself with no code change.

Resolution: closed not a bug

Reason: Maintainer facundobatista explained on 2022-12-07 that humans use the curated default output while `--format` exists for other processes, so YAML's readability brings no benefit; the reporter conceded and self-closed the issue. No commit or PR implemented YAML output — PR #933 (commit 2f673059) only reworded `--format` help text to say only json is supported, fixing #794.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Currently only 'json' format is supported for `charmcraft status <charm_name> --format json`. The format option can be extended to yaml with simple code change as this will give the user the option to output the status in YAML format which is considered more readable format.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed not a bug Proposal to add YAML output to `charmcraft status --format` was declined; maintainer facundobatista noted the flag exists for machine consumption. Author rahulsinghcanonical agreed and closed it himself with no code change.
stealth/space-bunny-alpha — closed stale YAML output for charmcraft status was abandoned after the author agreed --format targets machine consumers, not human readability; #940 closed without a code change.
stealth/space-bunny-alpha — closed not a bug YAML formatting for charmcraft status was declined; on 2022-12-07 the author agreed it did not enhance the feature and closed the issue without a code change.
qwen3.6-35b-a3b-mtp-q6 — — The request to add YAML formatting to charmcraft status was abandoned. The maintainer clarified the format flag is for machine consumption, not human readability. The author agreed and closed the issue.
qwen/qwen3.6-35b-a3b — — Rejected and closed by the author after maintainer feedback indicated the format flag is intended for machine consumption, making YAML readability unnecessary. The contributor agreed and withdrew the proposal.
qwen3.6-35b-a3b-mtp-q6 — — The YAML format proposal was rejected. A maintainer clarified the flag targets machine consumption, not human readability. The author agreed and closed the issue without implementation.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/charmcraft#933 (confidence 80%)

    Merged PR that documented that status --format supports only JSON, reinforcing the decision against adding YAML.

  • Related To: canonical/charmcraft#794 (confidence 75%)

    Issue fixed by the same commit 2f673059 clarifying the JSON-only --format help text.

Related issues

Issue Project State Summary Similarity
#933 Update the charmcraft status --format charmcraft merged Merged in canonical/charmcraft#933, commit 2f673059, clarifying that charmcraft status --format supports JSON only and fixing #794. YAML support was removed and split into #940.
74%
#913 Add `charmcraft fmt` command charmcraft open A maintainer-endorsed feature request to add `charmcraft format` for semantics-preserving charm file formatting remains open pending agreement on scope and standards.
70%