Starter/typescript-starter
1
0
Fork 0
mirror of synced 2025-11-08 12:57:47 +00:00
Code Issues Releases Wiki Activity

docs(readme): clarify release options

Browse Source
This commit is contained in:
Jason Dreyzehner
2018-03-11 17:08:00 -04:00
parent 3bf7a7ea0b
commit d86fc02cee
3 changed files with 29 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -150,15 +150,28 @@ npm run changelog
## One-step publish preparation script
Bringing together many of the steps above, this repo includes a one-step release command.
Bringing together many of the steps above, this repo includes a one-step release preparation command.
```bash
# Standard release
npm run release
# Release without bumping package.json version
npm run changelog -- --first-release
# PGP sign the release
npm run changelog -- --sign
# Prepare a standard release:
npm run prepare-release
```
You can also prepare a non-standard release:
```bash
# Or a non-standard release:
# Build everything
npm run all
# Then version it
npm run version -- --first-release # don't bump package.json version
npm run version -- --sign # PGP sign it
npm run version -- --prerelease alpha # alpha release
# And don't forget to push the docs to GitHub pages:
npm run docs:publish
```
This command runs the following tasks: