Skip to content

Commit

Permalink
Tweak release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
bytasv committed Aug 23, 2022
1 parent d7bd51e commit b426474
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,12 @@ If you would like to hack on MUI Toolpad or want to run the latest version, you

Running this command requires a [Github personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) with the `public_repo` scope.

Set `GITHUB_TOKEN` variable in `.env` file so to avoid passing it with command every time

**OR**

pass token with argument `--githubToken YOUR_TOKEN`

1. Copy the generated changelog from the console, clean it up, add a short summary of the release highlights and use the new version number as the title.

1. Prepend the changelog to [`CHANGELOG.md`](./CHANGELOG.md).
Expand All @@ -94,15 +100,27 @@ If you would like to hack on MUI Toolpad or want to run the latest version, you

1. Review/merge the PR — once the PR is merged to `master` a Docker image is built for the commit, tagged with the commit SHA and then pushed to Docker Hub, just like for any other commit in `master`.

1. Wait for the Docker build to finish.
1. Wait for the Docker build to finish. (You can find a job [here](https://app.circleci.com/pipelines/github/mui/mui-toolpad?branch=master))

1. Release the Docker image using:

```sh
# add --prerelease if necessary
yarn release:docker
yarn release:docker --githubToken YOUR_TOKEN
```

This command runs a Github action that retags the Docker image of the release commit in `master` to the version being released and also to "latest", and pushes those new tags. During the release, no new Docker images are created.

1. [Create a new Github release](https://docs.github.com/en/repositories/releasing-projects-on-github). Use `<version number>` as the tag and `<commit of merged PR>` as the target. Use the cleaned changelog as the body and the `<version number>` as the title. Mark as prerelease if necessary.
1. [Create a new Github release](https://github.com/mui/mui-toolpad/releases/new).

1. Use `<version number>` to **Choose a tag** (when you enter new version GH UI will pop a suggestion `Create new tag: *** on publish`)

1. Use `<commit of merged PR>` as the **target**

1. Use the cleaned changelog as the content of **Describe this release**

1. Use `<version number>` as the **Release title**

1. Mark as prerelease if necessary.

1. **Publish release**

0 comments on commit b426474

Please sign in to comment.