Skip to content

Commit

Permalink
docs: change prerelease command
Browse files Browse the repository at this point in the history
  • Loading branch information
theo-mesnil committed Feb 14, 2024
1 parent 2c7a059 commit dbc2f01
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 8 deletions.
10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,24 +99,18 @@ The release of the packages is automated by the CI, you just need to bump packag

**The commands listed below will only prompt for packages to bump**. Then they will modify packages versions, commit changes and create the git tag to finally push everything to github. **No further actions are required once you have validated the packages to bump.**

#### If you just need to bump one version without bumping to a major or switching from a prerelease to stable release, run:
#### If you just need to bump one version without switching from a prerelease to stable release, run:

```bash
yarn release
```

#### To bump to a major version, run:

```bash
yarn release major
```

#### To create a new prerelease, run:

This is only used for the **first** prerelease. If you already published a v5.0.0-alpha.0 then you just need to run the first command.

```bash
yarn release --preid alpha
yarn prerelease
```

NB: you can replace alpha with any other keyword (beta, rc, ...)
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
"postinstall": "husky install",
"pre-build": "yarn icons:collect",
"release": "yarn lerna version --conventional-commits --no-private",
"prerelease": "yarn lerna version --no-private --preid alpha",
"start": "yarn docs:dev",
"test": "yarn jest",
"watch": "onchange 'packages/**/*.ts*' -e '**/dist/**' -- node -r esm scripts/watch.js {{changed}}",
Expand Down

0 comments on commit dbc2f01

Please sign in to comment.