Skip to content

Commit 8a582c6

Browse files
committed
Merge pull request react-bootstrap#747 from react-bootstrap/release-management
Introduce Release Candidate process for breaking changes
2 parents 1b98730 + 33b0de3 commit 8a582c6

File tree

3 files changed

+16
-4
lines changed

3 files changed

+16
-4
lines changed

MAINTAINING.md

+13-2
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,18 @@ violation of semver, than a patch release reverting the offending change should
8787
be pushed as soon as possible to correct the error. The offending change can
8888
then be re-applied and released with the proper version bump.
8989

90-
## Live releasing the documentation
90+
### Release Candidates
91+
92+
In an effort to reduce the frequency with which we introduce breaking changes we
93+
should do our best to first push deprecation warnings in a Minor or Patch
94+
release. Also, Pull Requests with breaking changes should be submitted against
95+
the `vX-rc` branch, where X is the next Major version. Which we will in turn
96+
release as an `alpha` release of the next Major version. When we are ready to
97+
release the next Major version bump we will merge the `vX-rc` branch into the
98+
`master` branch and cut a `beta` release. Once bugs have been addressed with
99+
the `beta` release then we will release the Major version bump.
100+
101+
### Live releasing the documentation
91102

92103
The documentation release script does a similar job to the release script except
93104
that it doesn't publish to npm. It will auto tag the current branch with
@@ -122,7 +133,7 @@ Example usage of release-docs script:
122133
$ ./tools/release-docs
123134
```
124135

125-
## Check everything is OK before releasing
136+
### Check everything is OK before releasing
126137

127138
Release tools have a very useful option `--dry-run`.
128139

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
[![devDependency Status][dev-deps-badge]][dev-deps]
1313
[![peerDependency Status][peer-deps-badge]][peer-deps]
1414

15-
__Under active development - APIs will change.__ Check out the [1.0.0 Roadmap](https://github.com/react-bootstrap/react-bootstrap/wiki#100-roadmap) and [Contributing Guidelines][contributing] to see where you can help out.
15+
__Under active development - APIs will change.__ Check out the [1.0.0 Roadmap](https://github.com/react-bootstrap/react-bootstrap/wiki#100-roadmap) and [Contributing Guidelines][contributing] to see where you can help out. Prior to the 1.0.0 release, breaking changes should result in a Minor version bump.
1616

1717
## Docs
1818

docs/src/HomePage.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ export default class HomePage extends React.Component{
2626
href='https://github.com/react-bootstrap/react-bootstrap/wiki#100-roadmap'>1.0.0
2727
Roadmap</a> and <a
2828
href='https://github.com/react-bootstrap/react-bootstrap/blob/master/CONTRIBUTING.md'>Contributing
29-
Guidelines</a> to see where you can help out.
29+
Guidelines</a> to see where you can help out. Prior to the 1.0.0 release, breaking changes should
30+
result in a Minor version bump.
3031
</Alert>
3132
</Grid>
3233

0 commit comments

Comments
 (0)