← Back to issue list

Provide a better error message when loading a multi-document yaml

View original Github issue

Metadata

Project
craft-application
Number
#485
Type
issue
State
open
Author
lengau
Labels
—
Created
Updated
Closed
—

Current evaluation

Requests a clearer unsupported multi-document YAML error instead of PyYAML ComposerError/internal error. Current safe_yaml_load wraps YAMLError but lacks a specific multi-document message.

Suggested action: keep open

Reason: Maintainer-authored issue with a concrete reproducer and desired behavior; the Jira bot comment indicates internal ticket CRAFT-3411. Current code wraps YAMLError via YamlError.from_yaml_error but does not add the requested multi-document-specific message, so the issue remains valid.

Evaluated by: mr-cal-bot

Impact: 30 Quick Win: 18 Complexity: 25 Confidence: 75 Actionability: 80

Issue body

### What needs to get done Right now the workflow when reading a multi-document yaml file returns an internal error: ``` $ charmcraft pack charmcraft internal error: ComposerError('expected a single document in the stream', <yaml.error.Mark object at 0x73a1c3d77970>, 'but found another document', <yaml.error.Mark object at 0x73a1c3ce0340>) Full execution log: '/home/lengau/.local/state/charmcraft/log/charmcraft-20240920-152105.956862.log' ``` This should be converted to an error message that we don't support multi-document YAML files. ### Why it needs to get done Strange ux. See: https://github.com/canonical/charmcraft/issues/214

Evaluation history

Date Model Scores Action Summary
~deepseek/deepseek-pro-latest
Impact: 30
Quick Win: 18
Complexity: 25
Confidence: 75
Actionability: 80
keep open Requests a clearer unsupported multi-document YAML error instead of PyYAML ComposerError/internal error. Current safe_yaml_load wraps YAMLError but lacks a specific multi-document message.
stealth/space-bunny-alpha
Impact: 28
Quick Win: 21
Complexity: 18
Confidence: 94
Actionability: 91
keep open Multi-document project YAML still surfaces PyYAML's ComposerError as an internal error. The requested clearer unsupported-format message remains open.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 19
Complexity: 20
Confidence: 70
Actionability: 80
keep open Improve error message for multi-document YAML loading by converting raw ComposerError to user-friendly message indicating unsupported format.
qwen/qwen3.8-27b
Impact: 30
Quick Win: 26
Staleness: 55
Complexity: 15
Confidence: 72
Support Request: 0
needs triage Request to improve the error message when loading multi-document YAML files, currently showing a raw ComposerError instead of a clear 'not supported' message. Untriaged, no labels, no maintainer response since the Jira bot comment.
qwen/qwen3.6-35b-a3b
Staleness: 90
Complexity: 10
Confidence: 85
Support Request: 10
needs triage Unlabelled request to replace an internal ComposerError with a clear message stating multi-document YAML is unsupported. Currently inactive for over a year with only automated comments, awaiting maintainer assessment.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 20
Confidence: 85
Support Request: 20
needs triage Request to replace an internal ComposerError with a clear user-facing message indicating multi-document YAML files are unsupported. Currently untriaged and inactive for over a year.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/craft-application#427 (confidence 80%)

    Commit df906c31 wrapped YAML errors, likely converting the internal ComposerError into a YamlError but not adding the requested multi-document-specific message.

Related issues

No related issues found above the similarity threshold.