Skip to content

Commit e2e3cbd

Browse files
author
Fernando Saint-Jean
committed
#1 - adds release documentation
1 parent 47f44e0 commit e2e3cbd

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

RELEASE.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Feign Annotation Error Decoder 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+
You can do this either from the command line or via the github UI by creating a release.
16+
17+
1. **Wait for Travis CI**
18+
19+
This part is controlled by [`travis/publish.sh`](travis/publish.sh). It creates a couple commits, bumps the version,
20+
publishes artifacts, syncs to Maven Central.
21+
22+
## Credentials
23+
24+
Credentials of various kind are needed for the release process to work. If you notice something
25+
failing due to unauthorized, re-encrypt them using instructions at the bottom of the `.travis.yml`
26+
27+
Ex You'll see comments like this:
28+
```yaml
29+
env:
30+
global:
31+
# Ex. travis encrypt BINTRAY_USER=your_github_account
32+
- secure: "VeTO...
33+
```
34+
35+
To re-encrypt, you literally run the commands with relevant values and replace the "secure" key with the output:
36+
37+
```bash
38+
$ travis encrypt BINTRAY_USER=adrianmole
39+
Please add the following to your .travis.yml file:
40+
41+
secure: "mQnECL+dXc5l9wCYl/wUz+AaYFGt/1G31NAZcTLf2RbhKo8mUenc4hZNjHCEv+4ZvfYLd/NoTNMhTCxmtBMz1q4CahPKLWCZLoRD1ExeXwRymJPIhxZUPzx9yHPHc5dmgrSYOCJLJKJmHiOl9/bJi123456="
42+
```

0 commit comments

Comments
 (0)