← Back to issue list

Enrich `CraftErrors` with resolutions and documentation links

View original Github issue

Metadata

Project
snapcraft
Number
#4861
Type
issue
State
open
Author
mr-cal
Labels
Status: Triaged Type: Enhancement
Created
Updated
Closed
—

Current evaluation

CraftError metadata is supported and used in several paths, but the audit remains incomplete: multiple Snapcraft errors still lack details, resolutions, or documentation links.

Suggested action: keep open

Reason: The enhancement is maintainer-authored and labeled Triaged, and current code shows partial adoption of resolution, details, and docs_url fields. However, errors such as PluginsCommand's unsupported-base message still contain only a message, and several ExtensionError paths omit useful metadata; no single resolving commit or PR was identified.

Evaluated by: mr-cal-bot

Impact: 48 Quick Win: 12 Complexity: 57 Confidence: 88 Actionability: 58

Issue body

### What needs to get done Enrich existing [`CraftErrors`](https://canonical-craft-cli.readthedocs-hosted.com/en/latest/craft_cli.errors/#craft_cli.errors.CraftError) with `details`, `resolution`, `docs_url`, etc. ### Why it needs to get done For a better UX when errors are raised. This is a one-time task to improve existing `CraftErrors`. In the future, new `CraftErrors` should define as many error fields as possible.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 48
Quick Win: 12
Complexity: 57
Confidence: 88
Actionability: 58
keep open CraftError metadata is supported and used in several paths, but the audit remains incomplete: multiple Snapcraft errors still lack details, resolutions, or documentation links.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 19
Complexity: 20
Confidence: 90
Actionability: 80
close resolved Enhancement to add details, resolution, docs_url fields to CraftError. Already implemented in craft-cli/errors.py with all fields present and properly typed.
qwen/qwen3.8-27b
Impact: 35
Quick Win: 19
Staleness: 55
Complexity: 45
Confidence: 72
Support Request: 5
keep open Enhancement to enrich existing CraftError instances across craft-cli with resolution, docs_url, and details fields for better error UX. Triaged by maintainer, no active work in ~7 months.
qwen/qwen3.6-35b-a3b
Staleness: 75
Complexity: 40
Confidence: 85
Support Request: 5
keep open Enhancement to enrich CraftErrors with resolution details and documentation links for improved UX. Triaged by maintainer, currently inactive for ~5.8 months with only an automated Jira sync comment.
qwen3.6-35b-a3b-mtp-q6
Staleness: 80
Complexity: 30
Confidence: 80
Support Request: 5
keep open Enhancement to add resolution details and documentation links to CraftErrors for improved UX. Triaged by maintainer, currently awaiting implementation after 5 months of inactivity.

Update history

No update history recorded yet.

Related issues

No related issues found above the similarity threshold.