Skip to content

feat(create-release-branch): add a header, step results, and a release summary - #163

Draft
GuillaumeRx wants to merge 3 commits into
gr/crb-output-03-warningsfrom
gr/crb-output-04-summary
Draft

GuillaumeRx wants to merge 3 commits into
gr/crb-output-03-warningsfrom
gr/crb-output-04-summary

Conversation

@GuillaumeRx

@GuillaumeRx GuillaumeRx commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Explanation

Last step of the output revamp: a run now has a clear start, a result for each step, and a summary at the end.

  • The run opens with a header: the tool name, then the project name, its shape, and the mode.
  • Each step ends with what it did, for example Created branch release/2.0.0, Bumped 3 packages, or Installed dependencies. step and task take a result option for this.
  • The commits print as Committed "Initialize Release <v>" and Committed "Update Release <v>".
  • The editor wait is shown as Waiting for your editor to close RELEASE_SPEC.yml, then Closed RELEASE_SPEC.yml.
  • The run ends with a next step, a box with the branch and each released package and its new version, and Release <v> is ready on release/<v>.
  • The release UI prints its address and says what to do when the browser cannot open. The summary replaces the shutdown message.

Example run on a monorepo, as plain output:

┌  create-release-branch  @metamask/core-monorepo · monorepo · legacy mode
│
◇  Switched to branch release/1398.0.0
│
●  Waiting for your editor to close RELEASE_SPEC.yml
│
◇  Closed RELEASE_SPEC.yml
│
◇  Bumped 2 packages
│
◇  Fixed Yarn constraints
│
◇  Installed dependencies
│
◇  Deduplicated dependencies
│
◇  Committed "Update Release 1398.0.0"
│
●  Next: review the changelogs, then push the branch and open the release PR.
│
◇  2 packages released ───────────╮
│                                 │
│  Branch  release/1398.0.0       │
│                                 │
│  @metamask/utils        12.0.2  │
│  @metamask/byte-utils   0.1.1   │
│                                 │
├─────────────────────────────────╯
│
└  Release 1398.0.0 is ready on release/1398.0.0

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 17:27
@GuillaumeRx
GuillaumeRx force-pushed the gr/crb-output-04-summary branch from 9177e2e to 56f404b Compare November 5, 2026 17:49
@GuillaumeRx
GuillaumeRx force-pushed the gr/crb-output-04-summary branch from 56f404b to cfcd181 Compare November 5, 2026 18:16

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