@@ -32,23 +32,32 @@ This project's reference documentation is generated by Javadoc and resides in th
32
32
Common tasks:
33
33
34
34
* ` gradle javadoc ` - generate the reference documentation locally.
35
- * ` gradle gh-pages ` - update the hosted reference documentation on Github Pages (requires push privilege on ` origin `
36
- git remote)
37
35
38
36
### Releasing
39
37
40
- ** TODO**
41
-
42
- * dependencies
43
- * build
44
- * test
45
- * version bumping (needs to be a valid version that isn't already used)
46
- * ossrh signing keys
47
- * automation
48
- * tagging
49
- * github pages uploading
50
- * maven central publishing
51
- * github release uploading
38
+ In order to create a release, the following should be completed in order.
39
+
40
+ 1 . Ensure all the tests are passing (` gradle check ` ) and that there is enough test coverage.
41
+ 1 . Make sure you are on the ` master ` branch of the repository, with all changes merged/commited already.
42
+ 1 . Update the version number in the source code and the README. See [ Versioning] ( #versioning ) for information
43
+ about selecting an appropriate version number. Files to change:
44
+ - src/main/java/com/opentok/constants/Version.java
45
+ - build.gradle
46
+ - README.md
47
+ 1 . Commit the version number change with the message "Update to version x.x.x", substituting the new version number.
48
+ 1 . Create a git tag: ` git tag -a vx.x.x -m "Release vx.x.x" `
49
+ 1 . Ensure that you have permission to update the OSSRH repository. The following system properties must be set:
50
+ - ` ossrhUsername `
51
+ - ` ossrhPassword `
52
+ - ` signing.keyId `
53
+ - ` signing.password `
54
+ - ` signing.secretKeyRingFile `
55
+ 1 . Run ` gradle uploadArchives ` to create a staging release.
56
+ 1 . Login to [ OSSRH] ( https://oss.sonatype.org/ ) and promote the staging release to a public release.
57
+ 1 . Change the version number for future development by adding "-alpha.1" in each file, then make another commit with the
58
+ message "Begin development on next version".
59
+ 1 . Push the changes to the source repository: ` git push origin master `
60
+ 1 . Create a zip for uploading the release to Github Releases
52
61
53
62
### IDE Integration
54
63
@@ -65,8 +74,7 @@ The project uses [semantic versioning](http://semver.org/) as a policy for incre
65
74
work that will go into a future version, there should be a Milestone created in the Github Issues named with the version
66
75
number (e.g. "v2.2.1").
67
76
68
- ** TODO** During development the version number should end in "-pre". The version number is hardcoded into the class
69
- ` com.opentok.constants.Version ` , and also specified in ` build.gradle ` .
77
+ During development the version number should end in "-alpha.x" or "-beta.x", where x is an increasing number starting from 1.
70
78
71
79
### Branches
72
80
@@ -94,4 +102,4 @@ Issues are labelled to help track their progress within the pipeline.
94
102
95
103
### Management
96
104
97
- When in doubt, find the maintainers and ask.
105
+ When in doubt, find the maintainers and ask.
0 commit comments