Skip to content

Commit 4646e9b

Browse files
authored
Merge pull request #62 from ExpediaDotCom/AddInstructionsForRelease
Add instructions to README.md for the release process.
2 parents 0bbd56a + bbfef61 commit 4646e9b

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,21 @@ For a full build, including unit tests you can run the following
2323
```
2424
./mvnw clean package
2525
```
26+
27+
### Releases
28+
1. Decide what kind of version bump is necessary, based on [Semantic Versioning](http://semver.org/) conventions.
29+
In the items below, the version number you select will be referred to as `x.y.z`.
30+
2. Update the [pom.xml](https://github.com/ExpediaDotCom/haystack-client-java/blob/master/pom.xml),
31+
changing the version element to `<version>x.y.z</version>`. Note the *removal* of the `-SNAPSHOT` suffix.
32+
3. Update the
33+
[ReleaseNotes.md]((https://github.com/ExpediaDotCom/haystack-client-java/blob/master/ReleaseNotes.md))
34+
file with details of your changes.
35+
5. Create a pull request with your changes.
36+
6. Ask for a review of the pull request; when it is approved, the Travis CI build will upload the resulting jar file
37+
to the [SonaType Staging Repository](https://oss.sonatype.org/#stagingRepositories).
38+
This will cause the jar file to be released to the
39+
[SonaType Release Repository](https://oss.sonatype.org/#nexus-search;quick~haystack-client-java).
40+
7. Now you have to *put back* the -SNAPSHOT that you removed in step 2. When you do that, bump the `z` value to `z + 1`
41+
to minimize the chance of somebody trying to release on top of the x.y.z version you just released. Note that the next
42+
release might not use `x.y.z+1`; it could instead be `x.y+1.0` or `x+1.0.0`
43+
8. Create another pull request with the change from step 7 and get it merged.

0 commit comments

Comments
 (0)