Skip to content

Commit

Permalink
[docs] Update release instructions (mui#36113)
Browse files Browse the repository at this point in the history
  • Loading branch information
mj12albert authored Feb 9, 2023
1 parent 2d67942 commit 1fbb751
Showing 1 changed file with 16 additions and 12 deletions.
28 changes: 16 additions & 12 deletions scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,19 @@

A typical release goes like this:

### Prerequisites

1. You must be a member of the `@mui` org in npm to publish the release
1. 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
```
1. Make sure you have added the `material-ui-docs` remote to deploy the documentation:
```sh
git remote add material-ui-docs https://github.com/mui/material-ui-docs.git
```

### Prepare

The following steps must be proposed as a pull request.
Expand All @@ -20,7 +33,7 @@ The following steps must be proposed as a pull request.

### Release

1. checkout merge commit of the merged PR
1. Checkout merge commit of the merged PR
1. `yarn`
1. `yarn release:build`
1. `yarn release:publish`
Expand All @@ -29,17 +42,8 @@ The following steps must be proposed as a pull request.

### Documentation

Push the next branch on the release branch to deploy the documentation with the latest changes. It lives at https://material-ui.netlify.app/. Force push if necessary.

Note: if you don't have the `material-ui-docs` remote already, you should add it with

```sh
git remote add material-ui-docs https://github.com/mui/material-ui-docs.git
```

```sh
yarn docs:deploy
```
`yarn docs:deploy` to deploy the documentation (it lives at https://material-ui.netlify.app/) with the latest changes.
Force push if necessary.

### Announce

Expand Down

0 comments on commit 1fbb751

Please sign in to comment.