Skip to content

Commit

Permalink
[core] Clarify the release strategy (mui#16014)
Browse files Browse the repository at this point in the history
Co-authored-by: Andrew Cherniavskii <andrew.cherniavskii@gmail.com>
  • Loading branch information
MBilalShafi and cherniavskii authored Dec 28, 2024
1 parent 2799763 commit 7bc37b2
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,12 @@ 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).
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.
> [!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 7bc37b2

Please sign in to comment.