Skip to content

Commit

Permalink
[docs] Improve release documentation (#16321)
Browse files Browse the repository at this point in the history
  • Loading branch information
MBilalShafi authored Jan 27, 2025
1 parent cbe47de commit 21e98f7
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,14 @@ In case of a problem, another method to generate the changelog is available at t
2. Clean the generated changelog, to match the format of [https://github.com/mui/mui-x/releases](https://github.com/mui/mui-x/releases).
3. Update the root `package.json`'s version
4. Update the versions of the other `package.json` files and of the dependencies with `pnpm release:version` (`pnpm release:version prerelease` for alpha / beta releases).
> [!WARNING]
> Make sure of the following when versioning the packages with `release:version`:
>
> - Do not skip the version bump if Lerna detects a change in the package. It is important to release the package if there are **any** changes to it.
> - If Lerna doesn't suggest a version bump for the package, don't release it.
> - When releasing a package, make sure to sync the version of the package with the version of the root `package.json` file.

> [!WARNING]
> Make sure of the following when versioning the packages with `release:version`:
>
> - Do not skip the version bump if Lerna detects a change in the package. It is important to release the package if there are **any** changes to it.
> - If Lerna doesn't suggest a version bump for the package, don't release it.
> - When releasing a package, make sure to sync the version of the package with the version of the root `package.json` file.
5. Open PR with changes and wait for review and green CI.
6. Once CI is green and you have enough approvals, send a message on the `team-x` slack channel announcing a merge freeze.
7. Merge PR.
Expand Down

0 comments on commit 21e98f7

Please sign in to comment.