@@ -11,6 +11,14 @@ It prevents `danger` steps (`git push`, `npm publish` etc) from accidental runni
11
11
12
12
** For actual running your command please add ` --run ` option.**
13
13
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
+
14
22
---
15
23
16
24
#### Description
@@ -30,7 +38,7 @@ then name the `bower` github repo as
30
38
` original-project-name-bower ` .
31
39
32
40
Add ` 'release-script'.bowerRepo ` into your ` package.json ` :
33
- ``` js
41
+ ``` json
34
42
"release-script" : {
35
43
"bowerRepo" :
" [email protected] :<author>/original-project-name-bower.git"
36
44
}
@@ -59,7 +67,7 @@ Just create additional github repo for your static documents site.
59
67
E.g. [ react-bootstrap.github.io.git] ( https://github.com/react-bootstrap/react-bootstrap.github.io )
60
68
61
69
Add it as ` 'release-script'.docsRepo ` into your ` package.json ` :
62
- ``` js
70
+ ``` json
63
71
"release-script" : {
64
72
"docsRepo" :
" [email protected] :<author>/original-project-name-github.io.git"
65
73
}
@@ -71,7 +79,7 @@ Default folders for documents are:
71
79
It is advised to add them both into ` .gitignore ` .
72
80
73
81
You can customize them as you need:
74
- ``` js
82
+ ``` json
75
83
"release-script" : {
76
84
"docsRepo" :
" [email protected] :<author>/original-project-name-github.io.git"
77
85
"docsRoot" : " docs-built" ,
@@ -152,7 +160,7 @@ It is advised to add `bowerRoot` and `tmpBowerRepo` folders to your `.gitignore`
152
160
All options are optional.
153
161
154
162
E.g.:
155
- ``` js
163
+ ``` json
156
164
"release-script" : {
157
165
"bowerRepo" :
" [email protected] :<org-author-name>/<name-of-project>-bower.git" ,
158
166
"bowerRoot" : " amd" ,
@@ -220,7 +228,7 @@ If command line `--only-docs` option is set, then `github`, `npm` and `bower` pu
220
228
```
221
229
222
230
If you need ` bower ` releases too, then add ` 'release-script'.bowerRepo ` into your ` package.json ` like this:
223
- ``` js
231
+ ``` json
224
232
"release-script" : {
225
233
"bowerRepo" :
" [email protected] :<org-author-name>/<name-of-project>-bower.git"
226
234
}
@@ -247,7 +255,7 @@ Or you just can install `release-script` globally.
247
255
You also can add some helpful ` script ` commands to your ` package.json ` ,
248
256
and because ` npm ` adds ` node_modules/.bin ` into ` PATH ` for running scripts automatically,
249
257
you can add them just like that:
250
- ``` js
258
+ ``` json
251
259
"scripts" : {
252
260
...
253
261
"patch" : " release patch --run" ,
@@ -257,7 +265,7 @@ you can add them just like that:
257
265
```
258
266
259
267
Also you can add it like this:
260
- ` ` ` js
268
+ ```json
261
269
"scripts" : {
262
270
...
263
271
"release" : " release" ,
0 commit comments