diff --git a/scripts/README.md b/scripts/README.md index 4d1253d0c37fe9..2dd114f75bdaba 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -19,19 +19,19 @@ A minor release goes like this: The following steps must be proposed as a pull request. -1. Generate the changelog with `pnpm release:changelog` - The output must be prepended to the top level `CHANGELOG.md` - `pnpm release:changelog --help` for more information. If your GitHub token is not in your env, pass it as `--githubToken ` to the above command. - -2. Clean the generated changelog: +1. Fetch the upstream tags: `git fetch upstream --tags`. +2. Update the root `/package.json`'s version. +3. Generate the changelog with `pnpm release:changelog`: + - The output must be prepended to the top level `CHANGELOG.md` + - `pnpm release:changelog --help` for more information. If your GitHub token is not in your env, pass it as `--githubToken ` to the above command. +4. Clean the generated changelog: 1. Match the format of https://github.com/mui/material-ui/releases. 2. Change the packages names casing to be lowercase if applicable -3. Update the root `/package.json`'s version -4. Run `pnpm release:version`. Keep in mind: +5. Run `pnpm release:version`. Keep in mind: 1. Only packages that have changes since the last release should have their version bumped. 2. If they have changes, packages that follow Material-UI's versioning scheme should be bumped to the same version as the root `package.json`. This might require skipping some version numbers. -5. Open PR with changes and wait for review and green CI. -6. Merge PR once CI is green and it has been approved. +6. Open PR with changes and wait for review and green CI. +7. Merge PR once CI is green and it has been approved. #### Release