Skip to content
Merged
Changes from all commits
Commits
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
18 changes: 9 additions & 9 deletions scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <my-token>` 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 <my-token>` 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

Expand Down
Loading