Skip to content

Commit

Permalink
Merge pull request react-bootstrap#747 from react-bootstrap/release-m…
Browse files Browse the repository at this point in the history
…anagement

Introduce Release Candidate process for breaking changes
  • Loading branch information
mtscout6 committed May 28, 2015
2 parents 1b98730 + 33b0de3 commit 8a582c6
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 4 deletions.
15 changes: 13 additions & 2 deletions MAINTAINING.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,18 @@ violation of semver, than a patch release reverting the offending change should
be pushed as soon as possible to correct the error. The offending change can
then be re-applied and released with the proper version bump.

## Live releasing the documentation
### Release Candidates

In an effort to reduce the frequency with which we introduce breaking changes we
should do our best to first push deprecation warnings in a Minor or Patch
release. Also, Pull Requests with breaking changes should be submitted against
the `vX-rc` branch, where X is the next Major version. Which we will in turn
release as an `alpha` release of the next Major version. When we are ready to
release the next Major version bump we will merge the `vX-rc` branch into the
`master` branch and cut a `beta` release. Once bugs have been addressed with
the `beta` release then we will release the Major version bump.

### Live releasing the documentation

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

## Check everything is OK before releasing
### Check everything is OK before releasing

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

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
[![devDependency Status][dev-deps-badge]][dev-deps]
[![peerDependency Status][peer-deps-badge]][peer-deps]

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

## Docs

Expand Down
3 changes: 2 additions & 1 deletion docs/src/HomePage.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ export default class HomePage extends React.Component{
href='https://github.com/react-bootstrap/react-bootstrap/wiki#100-roadmap'>1.0.0
Roadmap</a> and <a
href='https://github.com/react-bootstrap/react-bootstrap/blob/master/CONTRIBUTING.md'>Contributing
Guidelines</a> to see where you can help out.
Guidelines</a> to see where you can help out. Prior to the 1.0.0 release, breaking changes should
result in a Minor version bump.
</Alert>
</Grid>

Expand Down

0 comments on commit 8a582c6

Please sign in to comment.