@@ -11,6 +11,14 @@ It prevents `danger` steps (`git push`, `npm publish` etc) from accidental runni
1111
1212** For actual running your command please add ` --run ` option.**
1313
14+ * If you don't want this behavior you can add ` "defaultDryRun": "false" ` into your ` package.json ` .*
15+ ``` json
16+ "release-script" : {
17+ "defaultDryRun" : " false"
18+ }
19+ ```
20+ * Then you can use ` --dry-run ` option for checks.*
21+
1422---
1523
1624#### Description
@@ -30,7 +38,7 @@ then name the `bower` github repo as
3038` original-project-name-bower ` .
3139
3240Add ` 'release-script'.bowerRepo ` into your ` package.json ` :
33- ``` js
41+ ``` json
3442"release-script" : {
3543 "bowerRepo" :
" [email protected] :<author>/original-project-name-bower.git" 3644}
@@ -59,7 +67,7 @@ Just create additional github repo for your static documents site.
5967E.g. [ react-bootstrap.github.io.git] ( https://github.com/react-bootstrap/react-bootstrap.github.io )
6068
6169Add it as ` 'release-script'.docsRepo ` into your ` package.json ` :
62- ``` js
70+ ``` json
6371"release-script" : {
6472 "docsRepo" :
" [email protected] :<author>/original-project-name-github.io.git" 6573}
@@ -71,7 +79,7 @@ Default folders for documents are:
7179It is advised to add them both into ` .gitignore ` .
7280
7381You can customize them as you need:
74- ``` js
82+ ``` json
7583"release-script" : {
7684 "docsRepo" :
" [email protected] :<author>/original-project-name-github.io.git" 7785 "docsRoot" : " docs-built" ,
@@ -152,7 +160,7 @@ It is advised to add `bowerRoot` and `tmpBowerRepo` folders to your `.gitignore`
152160All options are optional.
153161
154162E.g.:
155- ``` js
163+ ``` json
156164"release-script" : {
157165 "bowerRepo" :
" [email protected] :<org-author-name>/<name-of-project>-bower.git" ,
158166 "bowerRoot" : " amd" ,
@@ -220,7 +228,7 @@ If command line `--only-docs` option is set, then `github`, `npm` and `bower` pu
220228```
221229
222230If you need ` bower ` releases too, then add ` 'release-script'.bowerRepo ` into your ` package.json ` like this:
223- ``` js
231+ ``` json
224232"release-script" : {
225233 "bowerRepo" :
" [email protected] :<org-author-name>/<name-of-project>-bower.git" 226234}
@@ -247,7 +255,7 @@ Or you just can install `release-script` globally.
247255You also can add some helpful ` script ` commands to your ` package.json ` ,
248256and because ` npm ` adds ` node_modules/.bin ` into ` PATH ` for running scripts automatically,
249257you can add them just like that:
250- ``` js
258+ ``` json
251259"scripts" : {
252260 ...
253261 "patch" : " release patch --run" ,
@@ -257,7 +265,7 @@ you can add them just like that:
257265```
258266
259267Also you can add it like this:
260- ` ` ` js
268+ ```json
261269"scripts" : {
262270 ...
263271 "release" : " release" ,
0 commit comments