diff --git a/scripts/README.md b/scripts/README.md index e8c7d9426..392c9c621 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -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. @@ -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.