-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Creating readme for release process.
- Loading branch information
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Feign CDI Build & Release Process | ||
|
||
This repo uses [semantic versions](http://semver.org/). Please keep this in mind when choosing version numbers. | ||
|
||
1. **Alert others you are releasing** | ||
|
||
There should be no commits made to master while the release is in progress (about 10 minutes). Before you start | ||
a release, alert others on [gitter](https://gitter.im/OpenFeign/feign) so that they don't accidentally merge | ||
anything. If they do, and the build fails because of that, you'll have to recreate the release tag described below. | ||
|
||
1. **Push a git tag** | ||
|
||
The tag should be of the format `release-N.M.L`, for example `release-8.18.0`. | ||
|
||
1. **Wait for Travis CI** | ||
|
||
This part is controlled by [`travis/publish.sh`](travis/publish.sh). It creates a couple commits, bumps the version, | ||
publishes artifacts, syncs to Maven Central. | ||
|
||
## Credentials | ||
|
||
Credentials of various kind are needed for the release process to work. If you notice something | ||
failing due to unauthorized, check the repo settings in [Travis CI Settings[(https://travis-ci.org/OpenFeign/feign-cdi/settings). | ||
|
||
Delete any settings that seem like they're failing and re-add them. Do not use `travis encrypt` to create these environment variables. | ||
|
||
## Builds | ||
|
||
Commits to master just run a regular set of tests. Since all releases are pushed to bintray and sync'd to maven central, we cannot push snapshots. | ||
|
||
Releases include the extra `deploy` step that pushes the artifacts to bintray, creating the release. Once the release is created, the zipkin plugin syncs them to maven central. |