Skip to content

Commit a29e286

Browse files
committed
[core] Document new release strategy
1 parent f13dd69 commit a29e286

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

scripts/README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,21 @@ In case of a problem, another method to generate the changelog is available at t
3737

3838
2. Clean the generated changelog, to match the format of [https://github.com/mui/mui-x/releases](https://github.com/mui/mui-x/releases).
3939
3. Update the root `package.json`'s version
40-
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).
41-
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.
42-
If Lerna doesn't suggest a version bump for the package, don't release it.
40+
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). [Check the warning below]
4341
5. Open PR with changes and wait for review and green CI.
4442
6. Once CI is green and you have enough approvals, send a message on the `team-x` slack channel announcing a merge freeze.
4543
7. Merge PR.
4644

45+
:::warning
46+
47+
Make sure of the following when versioning the packages with `release:version`:
48+
49+
- 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.
50+
- If Lerna doesn't suggest a version bump for the package, don't release it.
51+
- When releasing a package, make sure to sync the version of the package with the version of the root `package.json` file.
52+
53+
:::
54+
4755
### Release the packages
4856

4957
1. Checkout the last version of the working branch

0 commit comments

Comments
 (0)