Skip to content

Commit e2599fd

Browse files
committed
updating development guidelines for release instructions
1 parent d9a4e21 commit e2599fd

File tree

2 files changed

+29
-21
lines changed

2 files changed

+29
-21
lines changed

DEVELOPING.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -32,23 +32,32 @@ This project's reference documentation is generated by Javadoc and resides in th
3232
Common tasks:
3333

3434
* `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)
3735

3836
### Releasing
3937

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
5261

5362
### IDE Integration
5463

@@ -65,8 +74,7 @@ The project uses [semantic versioning](http://semver.org/) as a policy for incre
6574
work that will go into a future version, there should be a Milestone created in the Github Issues named with the version
6675
number (e.g. "v2.2.1").
6776

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.
7078

7179
### Branches
7280

@@ -94,4 +102,4 @@ Issues are labelled to help track their progress within the pipeline.
94102

95103
### Management
96104

97-
When in doubt, find the maintainers and ask.
105+
When in doubt, find the maintainers and ask.

build.gradle

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ apply plugin: 'eclipse'
77
group = 'com.tokbox'
88
archivesBaseName = 'opentok-server-sdk'
99
// TODO: how do we increment this before/after a release for deployment and development?
10-
version = '2.2.0-pre'
10+
version = '2.2.0-beta.1'
1111

1212
sourceCompatibility = 1.6
1313

@@ -57,18 +57,18 @@ signing {
5757
sign configurations.archives
5858
}
5959

60-
ext.ossrhUsername = hasProperty('ossrhUsername') ? ossrhPassword : 'dummyuser'
60+
ext.ossrhUsername = hasProperty('ossrhUsername') ? ossrhUsername : 'dummyuser'
6161
ext.ossrhPassword = hasProperty('ossrhPassword') ? ossrhPassword : 'dummypass'
6262
uploadArchives {
6363
repositories {
6464
mavenDeployer {
6565
beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) }
6666

67-
repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2/") {
67+
repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2") {
6868
authentication(userName: ossrhUsername, password: ossrhPassword)
6969
}
7070

71-
snapshotRepository(url: "https://oss.sonatype.org/content/repositories/snapshots/") {
71+
snapshotRepository(url: "https://oss.sonatype.org/content/repositories/snapshots") {
7272
authentication(userName: ossrhUsername, password: ossrhPassword)
7373
}
7474

0 commit comments

Comments
 (0)