Skip to content

Commit 8c101e1

Browse files
authored
Adds release instructions (OpenFeign#460)
1 parent e1ad7fc commit 8c101e1

1 file changed

Lines changed: 40 additions & 0 deletions

File tree

RELEASE.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Feign Release Process
2+
3+
This repo uses [semantic versions](http://semver.org/). Please keep this in mind when choosing version numbers.
4+
5+
1. **Alert others you are releasing**
6+
7+
There should be no commits made to master while the release is in progress (about 10 minutes). Before you start
8+
a release, alert others on [gitter](https://gitter.im/OpenFeign/feign) so that they don't accidentally merge
9+
anything. If they do, and the build fails because of that, you'll have to recreate the release tag described below.
10+
11+
1. **Push a git tag**
12+
13+
The tag should be of the format `release-N.M.L`, for example `release-8.18.0`.
14+
15+
1. **Wait for Travis CI**
16+
17+
This part is controlled by [`travis/publish.sh`](travis/publish.sh). It creates a couple commits, bumps the version,
18+
publishes artifacts, syncs to Maven Central.
19+
20+
## Credentials
21+
22+
Credentials of various kind are needed for the release process to work. If you notice something
23+
failing due to unauthorized, re-encrypt them using instructions at the bottom of the `.travis.yml`
24+
25+
Ex You'll see comments like this:
26+
```yaml
27+
env:
28+
global:
29+
# Ex. travis encrypt BINTRAY_USER=your_github_account
30+
- secure: "VeTO...
31+
```
32+
33+
To re-encrypt, you literally run the commands with relevant values and replace the "secure" key with the output:
34+
35+
```bash
36+
$ travis encrypt BINTRAY_USER=adrianmole
37+
Please add the following to your .travis.yml file:
38+
39+
secure: "mQnECL+dXc5l9wCYl/wUz+AaYFGt/1G31NAZcTLf2RbhKo8mUenc4hZNjHCEv+4ZvfYLd/NoTNMhTCxmtBMz1q4CahPKLWCZLoRD1ExeXwRymJPIhxZUPzx9yHPHc5dmgrSYOCJLJKJmHiOl9/bJi123456="
40+
```

0 commit comments

Comments
 (0)