@@ -79,15 +79,28 @@ team](https://github.com/orgs/react-bootstrap/teams/publishers)
79
79
Example usages of the ` release-script ` :
80
80
81
81
``` bash
82
- $ npm run release patch
83
- $ npm run release minor
84
- $ npm run release major
85
- $ npm run release minor -- --preid beta Use both bump and preid for first prerelease
86
- $ npm run release -- --preid beta For follow on prereleases of the next version just use this
82
+ $ npm run release patch // without " --run" it will run in " dry run" mode
83
+ $ npm run release patch -- --run
84
+ $ npm run release minor -- --run
85
+ $ npm run release major -- --run
86
+ $ npm run release minor -- --preid beta --run Use both bump and preid for first prerelease
87
+ $ npm run release -- --preid beta --run For follow on prereleases of the next version just use this
87
88
```
88
89
89
90
* Note additional ` -- ` double-dash. It is important.*
90
91
92
+ Or if you have this line
93
+ ``` sh
94
+ export PATH=" ./node_modules/.bin:$PATH "
95
+ ```
96
+ in your shell config, then you can run it just as:
97
+ ``` bash
98
+ $ release patch // without " --run" it will run in " dry run" mode
99
+ $ release patch --run
100
+ $ release minor --preid beta --run
101
+ $ release --preid beta --run
102
+ ```
103
+
91
104
Note that the above commands will bump the [ semver] ( http://semver.org ) version
92
105
programmatically so you don't need to. Please be mindful to ensure that semver
93
106
guidelines are followed. If it is discovered that we have pushed a release in
@@ -131,7 +144,9 @@ To live patch the documentation in between release follow these steps
131
144
` git cherry-pick <commit-ish>... `
132
145
0 . Use the
133
146
``` bash
134
- $ npm run release -- --only-docs
147
+ $ npm run release -- --only-docs --run
148
+ // or
149
+ $ release --only-docs --run
135
150
```
136
151
to push and tag to the documentation repository.
137
152
@@ -142,13 +157,18 @@ easily.*
142
157
143
158
### Check everything is OK before releasing
144
159
145
- Release tools have a very useful option ` --dry-run ` .
160
+ Release tools are run in "dry run" mode by default.
161
+ It prevents ` danger ` steps (` git push ` , ` npm publish ` etc) from accidental running.
146
162
147
163
You can use it
148
164
- to learn how releasing tools are working.
149
165
- to ensure there are no side issues before you release anything.
150
166
``` bash
151
- $ npm run release -- --only-docs --dry-run
152
- $ npm run release major -- --dry-run
153
- $ npm run release minor -- --preid beta --dry-run
167
+ $ npm run release -- --only-docs
168
+ $ npm run release major
169
+ $ npm run release minor -- --preid beta
170
+ // or
171
+ $ release --only-docs
172
+ $ release major
173
+ $ release minor --preid beta
154
174
```
0 commit comments