diff --git a/RELEASING.md b/RELEASING.md index 9b0aa40..a632329 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -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.