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

[docs] Change markdown numbering syntax #36187

Merged
merged 1 commit into from
Feb 16, 2023
Merged

[docs] Change markdown numbering syntax #36187

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
22 changes: 11 additions & 11 deletions scripts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ 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
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
```
1. Make sure you have added the `material-ui-docs` remote to deploy the documentation:
3. 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
```
Expand All @@ -25,20 +25,20 @@ The following steps must be proposed as a pull request.
The output must be prepended to the top level `CHANGELOG.md`
`yarn release:changelog --help` for more information.

1. Clean the generated changelog, to match the format of https://github.com/mui/material-ui/releases.
1. Update the root `/package.json`'s version
1. `yarn release:version` (🔔 manually remove `^` from packages with prerelease version, eg. `-alpha`)
1. Open PR with changes and wait for review and green CI
1. Merge PR once CI is green and it has been approved
2. Clean the generated changelog, to match the format of https://github.com/mui/material-ui/releases.
3. Update the root `/package.json`'s version
4. `yarn release:version` (🔔 manually remove `^` from packages with prerelease version, eg. `-alpha`)
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

1. Checkout merge commit of the merged PR
1. `yarn`
1. `yarn release:build`
1. `yarn release:publish`
2. `yarn`
3. `yarn release:build`
4. `yarn release:publish`
You need your 2FA device.
1. `yarn release:tag`
5. `yarn release:tag`

### Documentation

Expand Down