Renamed the script 'deploy' to 'release'

This commit is contained in:
Aria Minaei 2021-10-04 14:25:11 +02:00
parent e32a456966
commit cf9b35bb4d
4 changed files with 10 additions and 10 deletions

View file

@ -1,5 +1,5 @@
if (process.env.THEATRE_IS_PUBLISHING !== 'true') {
throw Error(
`This script may run only when the "deploy" command in monorepo's root is running.`,
`This script may run only when the "release" command in monorepo's root is running.`,
)
}

View file

@ -13,7 +13,7 @@
"build:ts": "tsc --build ./devEnv/typecheck-all-projects/tsconfig.all.json",
"test": "jest",
"postinstall": "husky install",
"deploy": "zx scripts/deploy.mjs",
"release": "zx scripts/release.mjs",
"build:api-docs": "zx scripts/build-api-docs.mjs",
"lint:all": "eslint . --ext ts,tsx --ignore-path=.gitignore --rulesdir ./devEnv/eslint/rules"
},

View file

@ -1,9 +1,9 @@
/**
* The deploy script. This must be called with zx from the repo's root.
* The release script. This must be called with zx from the repo's root.
* Example:
* ```
* $ cd /path/to/repo
* $ yarn run deploy 0.4.2
* $ yarn run release 0.4.2
* ```
*/
import path from 'path'
@ -48,7 +48,7 @@ const packagesWhoseVersionsShouldBump = [
;(async function () {
// our packages will check for this env variable to make sure their
// prepublish script is only called from the `$ cd /path/to/monorepo; yarn run deploy`
// prepublish script is only called from the `$ cd /path/to/monorepo; yarn run release`
// @ts-ignore ignore
process.env.THEATRE_IS_PUBLISHING = true
@ -78,7 +78,7 @@ const packagesWhoseVersionsShouldBump = [
const version = argv._[argv._.length - 1]
if (typeof version !== 'string') {
console.error(
`You need to specify a version, like: $ yarn deploy 1.2.0-rc.4`,
`You need to specify a version, like: $ yarn release 1.2.0-rc.4`,
)
process.exit(1)
} else if (!version.match(/^[0-9]+\.[0-9]+\.[0-9]+(\-(dev|rc)\.[0-9]+)?$/)) {

View file

@ -1,6 +1,6 @@
## How to deploy
## How to release
Simply update the version of `theatre/package.json`, then run `$ yarn run deploy`. This script will:
1. Update the version of `@theatre/core` and `@theatre/studio`.
Simply update the version of `theatre/package.json`, then run `$ yarn run release`. This script will:
1. Update the version of `@theatre/core` and `@theatre/studio` and other dependencies.
2. Bundle the `.js` and `.dts` files.
3. Publish both packages to npm.
3. Publish all packages to npm.