Skip to content
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

Jump to bottom

Tweak release instructions #829

Merged
merged 2 commits into from
Aug 23, 2022
Merged

Tweak release instructions #829

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d25b8a9
Tweak release instructions
bytasv Aug 19, 2022
59495d1
Merge branch 'master' into tweak-release-guide
bytasv Aug 23, 2022
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
24 changes: 21 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
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,9 +100,9 @@ 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:
1. Release the Docker image using (requires Github authentication token):

```sh
# add --prerelease if necessary
Expand All @@ -105,4 +111,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**