Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[core] Improve release #16032

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+45 −41
Open

[core] Improve release #16032

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
682415d
[core] Improve release
oliviertassinari Dec 30, 2024
e9db806
sync
oliviertassinari Dec 30, 2024
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
4 changes: 2 additions & 2 deletions packages/x-charts-pro/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@
"charts"
],
"scripts": {
"prebuild": "rimraf --glob build \"*.tsbuildinfo\"",
"typescript": "tsc -p tsconfig.json",
"build": "pnpm build:modern && pnpm build:node && pnpm build:stable && pnpm build:types && pnpm build:copy-files ",
"build:modern": "node ../../scripts/build.mjs modern",
"build:node": "node ../../scripts/build.mjs node",
"build:stable": "node ../../scripts/build.mjs stable",
"build:copy-files": "node ../../scripts/copyFiles.mjs",
"build:types": "node ../../scripts/buildTypes.mjs",
"prebuild": "rimraf build tsconfig.build.tsbuildinfo"
"build:copy-files": "node ../../scripts/copyFiles.mjs"
},
"repository": {
"type": "git",
Expand Down
4 changes: 2 additions & 2 deletions packages/x-charts/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@
"charts"
],
"scripts": {
"prebuild": "rimraf --glob build \"*.tsbuildinfo\"",
"typescript": "tsc -p tsconfig.json",
"build": "pnpm build:modern && pnpm build:node && pnpm build:stable && pnpm build:types && pnpm build:copy-files ",
"build:modern": "node ../../scripts/build.mjs modern",
"build:node": "node ../../scripts/build.mjs node",
"build:stable": "node ../../scripts/build.mjs stable",
"build:copy-files": "node ../../scripts/copyFiles.mjs",
"build:types": "node ../../scripts/buildTypes.mjs",
"prebuild": "rimraf build tsconfig.build.tsbuildinfo"
"build:copy-files": "node ../../scripts/copyFiles.mjs"
},
"repository": {
"type": "git",
Expand Down
6 changes: 3 additions & 3 deletions packages/x-codemod/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@
"scripts": {
"test": "cd ../../ && cross-env NODE_ENV=test mocha 'packages/x-codemod/**/*.test.ts'",
"typescript": "tsc -p tsconfig.json",
"prebuild": "rimraf build",
"copy-files": "cpy README.md build && cpy package.json build",
"build": "node ../../scripts/build.mjs node --ignore 'src/types.ts' && pnpm copy-files"
"prebuild": "rimraf --glob build \"*.tsbuildinfo\"",
"build": "node ../../scripts/build.mjs node --ignore 'src/types.ts' && pnpm copy-files",
"copy-files": "cpy README.md build && cpy package.json build"
},
"repository": {
"type": "git",
Expand Down
4 changes: 2 additions & 2 deletions packages/x-data-grid-generator/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@
],
"scripts": {
"typescript": "tsc -p tsconfig.json",
"prebuild": "rimraf --glob build \"*.tsbuildinfo\"",
"build": "pnpm build:modern && pnpm build:node && pnpm build:stable && pnpm build:types && pnpm build:copy-files ",
"build:modern": "node ../../scripts/build.mjs modern",
"build:node": "node ../../scripts/build.mjs node",
"build:stable": "node ../../scripts/build.mjs stable",
"build:copy-files": "node ../../scripts/copyFiles.mjs",
"build:types": "node ../../scripts/buildTypes.mjs",
"prebuild": "rimraf build tsconfig.build.tsbuildinfo"
"build:copy-files": "node ../../scripts/copyFiles.mjs"
},
"repository": {
"type": "git",
Expand Down
4 changes: 2 additions & 2 deletions packages/x-data-grid-premium/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@
],
"scripts": {
"typescript": "tsc -p tsconfig.json",
"prebuild": "rimraf --glob build \"*.tsbuildinfo\"",
"build": "pnpm build:modern && pnpm build:node && pnpm build:stable && pnpm build:types && pnpm build:copy-files ",
"build:modern": "node ../../scripts/build.mjs modern",
"build:node": "node ../../scripts/build.mjs node",
"build:stable": "node ../../scripts/build.mjs stable",
"build:copy-files": "node ../../scripts/copyFiles.mjs",
"build:types": "node ../../scripts/buildTypes.mjs",
"prebuild": "rimraf build tsconfig.build.tsbuildinfo"
"build:copy-files": "node ../../scripts/copyFiles.mjs"
},
"repository": {
"type": "git",
Expand Down
4 changes: 2 additions & 2 deletions packages/x-data-grid-pro/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@
],
"scripts": {
"typescript": "tsc -p tsconfig.json",
"prebuild": "rimraf --glob build \"*.tsbuildinfo\"",
"build": "pnpm build:modern && pnpm build:node && pnpm build:stable && pnpm build:types && pnpm build:copy-files ",
"build:modern": "node ../../scripts/build.mjs modern",
"build:node": "node ../../scripts/build.mjs node",
"build:stable": "node ../../scripts/build.mjs stable",
"build:copy-files": "node ../../scripts/copyFiles.mjs",
"build:types": "node ../../scripts/buildTypes.mjs",
"prebuild": "rimraf build tsconfig.build.tsbuildinfo"
"build:copy-files": "node ../../scripts/copyFiles.mjs"
},
"repository": {
"type": "git",
Expand Down
4 changes: 2 additions & 2 deletions packages/x-data-grid/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,13 @@
],
"scripts": {
"typescript": "tsc -p tsconfig.json",
"prebuild": "rimraf --glob build \"*.tsbuildinfo\"",
"build": "pnpm build:modern && pnpm build:node && pnpm build:stable && pnpm build:types && pnpm build:copy-files ",
"build:modern": "node ../../scripts/build.mjs modern",
"build:node": "node ../../scripts/build.mjs node",
"build:stable": "node ../../scripts/build.mjs stable",
"build:copy-files": "node ../../scripts/copyFiles.mjs",
"build:types": "node ../../scripts/buildTypes.mjs",
"prebuild": "rimraf build tsconfig.build.tsbuildinfo"
"build:copy-files": "node ../../scripts/copyFiles.mjs"
},
"repository": {
"type": "git",
Expand Down
4 changes: 2 additions & 2 deletions packages/x-date-pickers-pro/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@
],
"scripts": {
"typescript": "tsc -p tsconfig.json",
"prebuild": "rimraf --glob build \"*.tsbuildinfo\"",
"build": "pnpm build:modern && pnpm build:node && pnpm build:stable && pnpm build:types && pnpm build:copy-files ",
"build:modern": "node ../../scripts/build.mjs modern",
"build:node": "node ../../scripts/build.mjs node",
"build:stable": "node ../../scripts/build.mjs stable",
"build:copy-files": "node ../../scripts/copyFiles.mjs",
"build:types": "node ../../scripts/buildTypes.mjs",
"prebuild": "rimraf build tsconfig.build.tsbuildinfo"
"build:copy-files": "node ../../scripts/copyFiles.mjs"
},
"repository": {
"type": "git",
Expand Down
4 changes: 2 additions & 2 deletions packages/x-date-pickers/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@
],
"scripts": {
"typescript": "tsc -p tsconfig.json",
"prebuild": "rimraf --glob build \"*.tsbuildinfo\"",
"build": "pnpm build:modern && pnpm build:node && pnpm build:stable && pnpm build:types && pnpm build:copy-files ",
"build:modern": "node ../../scripts/build.mjs modern",
"build:node": "node ../../scripts/build.mjs node",
"build:stable": "node ../../scripts/build.mjs stable",
"build:copy-files": "node ../../scripts/copyFiles.mjs",
"build:types": "node ../../scripts/buildTypes.mjs",
"prebuild": "rimraf build tsconfig.build.tsbuildinfo"
"build:copy-files": "node ../../scripts/copyFiles.mjs"
},
"repository": {
"type": "git",
Expand Down
4 changes: 2 additions & 2 deletions packages/x-internals/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@
],
"scripts": {
"typescript": "tsc -p tsconfig.json",
"prebuild": "rimraf --glob build \"*.tsbuildinfo\"",
"build": "pnpm build:modern && pnpm build:node && pnpm build:stable && pnpm build:types && pnpm build:copy-files ",
"build:modern": "node ../../scripts/build.mjs modern",
"build:node": "node ../../scripts/build.mjs node",
"build:stable": "node ../../scripts/build.mjs stable",
"build:copy-files": "node ../../scripts/copyFiles.mjs",
"build:types": "node ../../scripts/buildTypes.mjs",
"prebuild": "rimraf build tsconfig.build.tsbuildinfo"
"build:copy-files": "node ../../scripts/copyFiles.mjs"
},
"repository": {
"type": "git",
Expand Down
4 changes: 2 additions & 2 deletions packages/x-license/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@
},
"scripts": {
"typescript": "tsc -p tsconfig.json",
"prebuild": "rimraf --glob build \"*.tsbuildinfo\"",
"build": "pnpm build:modern && pnpm build:node && pnpm build:stable && pnpm build:types && pnpm build:copy-files ",
"build:modern": "node ../../scripts/build.mjs modern",
"build:node": "node ../../scripts/build.mjs node",
"build:stable": "node ../../scripts/build.mjs stable",
"build:copy-files": "node ../../scripts/copyFiles.mjs",
"build:types": "node ../../scripts/buildTypes.mjs",
"prebuild": "rimraf build tsconfig.build.tsbuildinfo"
"build:copy-files": "node ../../scripts/copyFiles.mjs"
},
"repository": {
"type": "git",
Expand Down
4 changes: 2 additions & 2 deletions packages/x-tree-view-pro/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@
],
"scripts": {
"typescript": "tsc -p tsconfig.json",
"prebuild": "rimraf --glob build \"*.tsbuildinfo\"",
"build": "pnpm build:modern && pnpm build:node && pnpm build:stable && pnpm build:types && pnpm build:copy-files ",
"build:modern": "node ../../scripts/build.mjs modern",
"build:node": "node ../../scripts/build.mjs node",
"build:stable": "node ../../scripts/build.mjs stable",
"build:copy-files": "node ../../scripts/copyFiles.mjs",
"build:types": "node ../../scripts/buildTypes.mjs",
"prebuild": "rimraf build tsconfig.build.tsbuildinfo"
"build:copy-files": "node ../../scripts/copyFiles.mjs"
},
"repository": {
"type": "git",
Expand Down
4 changes: 2 additions & 2 deletions packages/x-tree-view/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@
],
"scripts": {
"typescript": "tsc -p tsconfig.json",
"prebuild": "rimraf --glob build \"*.tsbuildinfo\"",
"build": "pnpm build:modern && pnpm build:node && pnpm build:stable && pnpm build:types && pnpm build:copy-files ",
"build:modern": "node ../../scripts/build.mjs modern",
"build:node": "node ../../scripts/build.mjs node",
"build:stable": "node ../../scripts/build.mjs stable",
"build:copy-files": "node ../../scripts/copyFiles.mjs",
"build:types": "node ../../scripts/buildTypes.mjs",
"prebuild": "rimraf build tsconfig.build.tsbuildinfo"
"build:copy-files": "node ../../scripts/copyFiles.mjs"
},
"repository": {
"type": "git",
Expand Down
32 changes: 18 additions & 14 deletions scripts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,17 @@

## Release

> Tip: For people who are doing the release for the first time, make sure you sign in to npm from the command line using security-key flow as well as have two-factor authentication enabled.
> You can follow [this guide](https://docs.npmjs.com/accessing-npm-using-2fa) for more information on how to set it up.

> Tip: You can use `release:publish:dry-run` to test the release process without actually publishing the packages.
> Be sure install [verdaccio](https://verdaccio.org/) (local npm registry) before doing it.
A typical release goes like this:

> Tip: You can copy raw markdown checklist below to the release Pull Request and follow it step by step marking completed items.
### Prerequisites

A typical release goes like this:
1. You must be a member of the `@mui` org in npm to publish the release.
2. Set up your npm authToken by logging into npm (`npm login`). This will save a token to `~/.npmrc` as a line that looks

Check warning on line 10 in scripts/README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "scripts/README.md", "range": {"start": {"line": 10, "column": 70}}}, "severity": "WARNING"}
like this:
```text
//registry.npmjs.org/:_authToken=npm_000000000000000000000000000000000000
```
3. Generate a GitHub Token at https://github.com/settings/personal-access-tokens/new and add it to your shell rc script (either `.bashrc` or `.zshrc`) as `GITHUB_TOKEN`.

### Prepare the release of the packages

Expand Down Expand Up @@ -50,25 +52,27 @@

### Release the packages

1. Checkout the last version of the working branch
2. `pnpm i && pnpm release:build` (make sure you have the latest dependencies installed, and build the packages)
3. `pnpm release:publish` (release the versions on npm, you need your 2FA device)
4. `pnpm release:tag` (push the newly created tag)
1. Checkout the last version of the working branch.
2. `pnpm i && pnpm release:build` (make sure you have the latest dependencies installed, and build the packages).
3. `pnpm release:publish` (release the versions on npm, you need your 2FA device).
4. `pnpm release:tag` (push the newly created tag).

> Tip: You can use `release:publish:dry-run` to test the release process without actually publishing the packages.
> Be sure install [verdaccio](https://verdaccio.org/) (local npm registry) before doing it.

### Publish the documentation

The documentation must be updated on the `docs-vX` branch (`docs-v4` for `v4.X` releases, `docs-v5` for `v5.X` releases, ...)

Push the working branch on the documentation release branch to deploy the documentation with the latest changes.
Push the working branch on the documentation release branch to deploy the documentation with the latest changes:

<!-- #default-branch-switch -->

```bash
pnpm docs:deploy
```

You can follow the deployment process [on the Netlify Dashboard](https://app.netlify.com/sites/material-ui-x/deploys?filter=docs-v7)
Once deployed, it will be accessible at https://material-ui-x.netlify.app/ for the `docs-v7` deployment.
You can follow the deployment process [on the Netlify Dashboard](https://app.netlify.com/sites/material-ui-x/deploys).

### Publish GitHub release

Expand Down
Loading