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 19, 2022
1 parent d7bd51e commit ca656c5
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ 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:

Expand All @@ -105,4 +105,16 @@ If you would like to hack on MUI Toolpad or want to run the latest version, you

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 ca656c5

Please sign in to comment.