Skip to content

Commit 835778a

Browse files
committedMar 3, 2023
added releasing guidelines
1 parent 19b8674 commit 835778a

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed
 

‎README.md

+6
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Contents
2626
- [Tests](#tests)
2727
- [Code style](#code-style)
2828
- [Static code analysis](#static-code-analysis)
29+
- [Releasing](#releasing)
2930
- [References](#references)
3031
- [License](#license)
3132

@@ -203,6 +204,11 @@ Static code analysis runs Checkstyle, FindBugs, PMD and Lint. It can be executed
203204

204205
Reports from analysis are generated in `library/build/reports/` directory.
205206

207+
Releasing
208+
----------
209+
210+
See [RELEASING.md](https://github.com/pwittchen/ReactiveSensors/blob/RxJava3.x/RELEASING.md) file.
211+
206212
References
207213
----------
208214
- [Sensors Overview](http://developer.android.com/guide/topics/sensors/sensors_overview.html)

‎RELEASING.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Releasing Guidelines
2+
====================
3+
4+
In order to release new version of the library, we need to perform the following operations:
5+
- create new release issue on GitHub
6+
- prepare release notes and put them to the issue
7+
- verify, commit and push changes to `gh-pages` branch
8+
- checkout to the appropriate branch (`RxJava1.x` or `RxJava2.x` or `RxJava3.x`)
9+
- bump library version (`VERSION_NAME` and `VERSION_CODE`) in `gradle.properties` file
10+
- commit and push the changes
11+
- run command: `./gradlew clean build test check uploadArchives closeAndReleaseRepository`
12+
- wait for the Maven Sync (up to 48 hours)
13+
- when sync is done, checkout to the `RxJava3.x` branch
14+
- update `CHANGELOG.md` file with new release version, current date and release notes
15+
- create new tagged GitHub release with name the same as `VERSION_NAME` from `gradle.properties` and release notes

0 commit comments

Comments
 (0)
Please sign in to comment.