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 #359

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[core] Improve release #359

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 12 additions & 16 deletions scripts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,15 @@ A typical release goes like this:

### Prerequisites

1. You must be a member of the `@mui` org in npm to publish the release
1. You must be a member of the `@pigment-css` 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
like this:
```text
//registry.npmjs.org/:_authToken=npm_000000000000000000000000000000000000
```
3. Make sure you have added the `material-ui-docs` remote to deploy the documentation:
```bash
git remote add material-ui-docs https://github.com/mui/material-ui-docs.git
```
4. 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`.
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
### Prepare the release of the packages

The following steps must be proposed as a pull request.

Expand All @@ -29,19 +25,19 @@ The following steps must be proposed as a pull request.
2. Clean the generated changelog:
1. Match the format of https://github.com/mui/pigment-css/releases.
2. Change the packages names casing to be lowercase if applicable
3. Update the root `/package.json`'s version
3. Update the root `/package.json`'s version.
4. Run `pnpm release:version`. Keep the package versions of stable public packages the same as the root `package.json` version.
5. Open PR with changes and wait for review and green CI
6. Merge PR once CI is green and it has been approved
5. Open PR with changes and wait for review and green CI.
6. Merge PR once CI is green and it has been approved.

### Release
### Release the packages

1. Checkout the last version of the release branch
2. `pnpm install && 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 release branch.
2. `pnpm install && 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).

### Documentation
### Publish the documentation

NOTE: We currently use the README.md as a documentation, so this step should be skipped.

Expand Down
Loading