diff --git a/RELEASE.adoc b/RELEASE.adoc deleted file mode 100644 index 59a7d42..0000000 --- a/RELEASE.adoc +++ /dev/null @@ -1,22 +0,0 @@ -## Release process - -This project uses a simplified release process, where you only need to push a tag starting with -`release-`, followed by a version number. For instance, pushing a tag named `release-0.9.3` would -tell Travis to release the version `0.9.3`. - -### TL;DR - -```bash -git checkout master -git fetch upstream -git rebase upstream/master -git tag release-0.9.3 -git push upstream release-0.9.3 -``` - -### Long version - -Once a new tag is pushed to the main repository, a Travis build will be started for it. Once the -build script detects that it's a release build, it will start a new Maven release process -(`mvn release:prepare release:perform`) and upload the artifacts to Bintray, which is synchronized -with Maven Central. \ No newline at end of file diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..afbc4a7 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,18 @@ +# Release process + +This project uses a simplified release process, where you only need to push a tag starting with `release-`, followed by a version number. For instance, pushing a tag named `release-0.9.3` would tell Travis CI to release the version `0.9.3`. + +## TL;DR + +```bash +git checkout master +git fetch upstream +git rebase upstream/master +git tag release-0.9.X +git push upstream release-0.9.X +``` + +## Explanation + +Once a new tag is pushed to the main repository, a Travis build will be started for it. +Once the build script detects that it's a release build, it will start a new Maven release process (`mvn release:prepare release:perform`) and upload the artifacts to Bintray, which is synchronized with Maven Central. \ No newline at end of file