simon/semantic-release
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(readme): document npm scripts automation capabilities

Browse Source
This commit is contained in:
Stephan Bönnemann 2015-02-02 15:54:43 +01:00
parent a1c86fc0d0
commit a48b0c957d
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -13,14 +13,17 @@ npm i semantic-release
Run `semantic-release pre` right before `npm publish` and `semantic-release post` right after. Run `semantic-release pre` right before `npm publish` and `semantic-release post` right after.
The post hook is automatable in `package.json` with a "postpublish" script: For maximum comfort you can automate this inside your `package.json`:
```json ```json
"scripts": { "scripts": {
"prepublish": "semantic-release pre"
"postpublish": "semantic-release post" "postpublish": "semantic-release post"
} }
``` ```
This is currently not possible for the "prepublish" hook. See [npm/npm#7118](https://github.com/npm/npm/issues/7118). Note: Even though `semantic-release` works around a limitation in npm's "prepublish" hook using it prints an error that you can *safely ignore*.
See [npm/npm#7118](https://github.com/npm/npm/issues/7118).
MIT License MIT License
2015 Stephan Bönnemann 2015 Stephan Bönnemann