Skip to content

Commit feb1998

Browse files
committed
Document release process.
1 parent 3b686a3 commit feb1998

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

RELEASING.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Release Process
2+
===============
3+
4+
1. Ensure `VERSION_NAME` in `gradle.properties` is set to the version you want to release.
5+
2. Add an entry in `CHANGELOG.md` with the changes for the release.
6+
3. Update `README.md` with the version about to be released. Also update the RxJava version in
7+
this file to its latest.
8+
4. Update the RxJava version in `rxandroid/build.gradle` to its latest. (We tell people that we
9+
won't be tracking RxJava releases, and we don't, but we do it anyway when we are releasing for
10+
those who ignore the advice.)
11+
5. Commit: `git commit -am "Prepare version X.Y.X"`
12+
6. Tag: `git tag -a X.Y.Z -m "Version X.Y.Z"`
13+
7. Update `VERSION_NAME` in `gradle.properties` to the next development version. For example, if
14+
you just tagged version 1.0.4 you would set this value to 1.0.5. Do NOT append "-SNAPSHOT" to
15+
this value, it will be added automatically.
16+
8. Commit: `git commit -am "Prepare next development version."`
17+
9. Push: `git push && git push --tags`
18+
10. Paste the `CHANGELOG.md` contents for this version into a Release on GitHub along with the
19+
Groovy for depending on the new version (https://github.com/ReactiveX/RxAndroid/releases).

0 commit comments

Comments
 (0)