Skip to content

Commit d344842

Browse files
committed
Merge pull request react-bootstrap#1329 from AlexKVal/human-factor
Update 'release-script' to 'human safe' version.
2 parents cf6ea2a + 07be1e1 commit d344842

File tree

2 files changed

+31
-11
lines changed

2 files changed

+31
-11
lines changed

MAINTAINING.md

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -79,15 +79,28 @@ team](https://github.com/orgs/react-bootstrap/teams/publishers)
7979
Example usages of the `release-script`:
8080

8181
```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
8788
```
8889

8990
*Note additional `--` double-dash. It is important.*
9091

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+
91104
Note that the above commands will bump the [semver](http://semver.org) version
92105
programmatically so you don't need to. Please be mindful to ensure that semver
93106
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
131144
`git cherry-pick <commit-ish>...`
132145
0. Use the
133146
```bash
134-
$ npm run release -- --only-docs
147+
$ npm run release -- --only-docs --run
148+
// or
149+
$ release --only-docs --run
135150
```
136151
to push and tag to the documentation repository.
137152

@@ -142,13 +157,18 @@ easily.*
142157

143158
### Check everything is OK before releasing
144159

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.
146162

147163
You can use it
148164
- to learn how releasing tools are working.
149165
- to ensure there are no side issues before you release anything.
150166
```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
154174
```

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@
9797
"react-component-metadata": "^1.3.0",
9898
"react-hot-loader": "^1.2.8",
9999
"react-router": "^0.13.3",
100-
"release-script": "^0.4.0",
100+
"release-script": "^0.5.0",
101101
"rimraf": "^2.4.2",
102102
"semver": "^5.0.1",
103103
"sinon": "^1.15.4",

0 commit comments

Comments
 (0)