Skip to content

chore: update release docs #313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adonesky1 merged 1 commit into from
Jun 9, 2026
+8 −19
Merged

chore: update release docs #313

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 8 additions & 19 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,15 @@ Creating a new release:

This repository uses [Github Actions](https://docs.github.com/en/actions) to release.

1. Start on the `main` branch and on latest
```
git checkout main
git pull origin main
```
1. Create a branch with the correct name: `release-v${version}`
1. Go to the [Create Release Pull Request](https://github.com/MetaMask/api-specs/actions/workflows/create-release-pr.yml) workflow on GitHub Actions and click **Run workflow**.

ex:
```
git checkout -b release-v0.0.1
```
1. Fill in the inputs:
- **base-branch**: `main` (default)
- **release-type**: a SemVer bump type — `major`, `minor`, or `patch` (mutually exclusive with `release-version`)
- **release-version**: a specific version to bump to, e.g. `0.15.0` (mutually exclusive with `release-type`)

1. Push the branch to origin
1. The workflow will open a Pull Request with version bumps and changelog updates.

```
git push origin release-v0.0.1
```
1. Review the pull request and merge when ready.

1. kicks off [.github/workflows/release-pr.yml](/.github/workflows/release-pr.yml)
1. A [Pull Request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) should be created
1. Review pull request
1. Merge PR when ready to release
1. Release kicks off and runs [.github/workflows/release-merge.yml](/.github/workflows/release-merge.yml)
1. Merging into `main` triggers [.github/workflows/publish-release.yml](/.github/workflows/publish-release.yml), which publishes the package to npm and deploys docs to GitHub Pages.
Loading