Skip to content

feat(create-release-branch): show actionable errors - #160

Draft
GuillaumeRx wants to merge 5 commits into
gr/crb-output-01-rendererfrom
gr/crb-output-02-errors
Draft

GuillaumeRx wants to merge 5 commits into
gr/crb-output-01-rendererfrom
gr/crb-output-02-errors

Conversation

@GuillaumeRx

@GuillaumeRx GuillaumeRx commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Explanation

Second step of the output revamp: errors tell the user what is wrong and how to fix it.

  • An error prints as a short title with its Caused by: lines. The stack trace only shows with DEBUG=create-release-branch:*.
  • Errors that the user can act on extend a new UserFacingError class and describe themselves.
  • Release rule errors are now data: { packageName, problem, hint }. The texts are rewritten to say what to do next.
  • Release spec problems are listed by line and package, with a dimmed hint under each one, and the path of the kept release spec at the end. An invalid YAML file shows where the parser stopped.
  • The release UI keeps the same JSON shape for its error messages.

References

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've communicated my changes to consumers by updating changelogs for packages I've changed
  • I've introduced breaking changes in this PR and have prepared draft pull requests for clients and consumer packages to resolve them

@GuillaumeRx
GuillaumeRx added this pull request to stack #161 November 5, 2026 16:58
@GuillaumeRx GuillaumeRx changed the title gr/crb output 02 errors feat(create-release-branch): show actionable errors Nov 5, 2026
@GuillaumeRx
GuillaumeRx force-pushed the gr/crb-output-02-errors branch from 015b34d to 164387d Compare November 5, 2026 17:49

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant