From 7bc37b29fa16abf8a731bc8260e71719e5611bd4 Mon Sep 17 00:00:00 2001 From: Bilal Shafi Date: Sat, 28 Dec 2024 12:20:24 +0500 Subject: [PATCH] [core] Clarify the release strategy (#16014) Co-authored-by: Andrew Cherniavskii --- scripts/README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/scripts/README.md b/scripts/README.md index ad2f7be8e9b4f..1df7b04885a3e 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -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.