Skip to content

Commit aa603d3

Browse files
authored
Add release readme. Post release tasks. (#33)
* Add release readme. Post release tasks. * Remove link
1 parent 6268478 commit aa603d3

File tree

2 files changed

+23
-4
lines changed

2 files changed

+23
-4
lines changed

RELEASE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# AWS Lambda OpenTracing Java SDK Release Process
2+
3+
## Release
4+
1. Run the ReleaseLambdaSDK jenkins job by selecting `Build with Parameters`, specifying the release version, and selecting `Build`. This job will handle the following tasks:
5+
* Run all tests
6+
* Build artifacts
7+
* Upload versioned artifacts to sonatype
8+
* Tag release version
9+
2. When the `ReleaseLambdaSDK` job finishes there should be an artifact in the [Sonatype staging repository](https://oss.sonatype.org/index.html#stagingRepositories). Verify that the artifact is staged by searching for `comnewrelic`, there should be a numbered artifact named similar to `comnewrelic-1234`.
10+
3. Select the artifact in the Sonatype staging repository, choose the `Content` tab, and verify that the files and version looks correct.
11+
4. Click "Close" (add a simple comment like "releasing 1.1.0") and wait until the "Release" option is available.
12+
5. Click "Release" (add a simple comment like "releasing 1.1.0") [note: keep the "Automatically Drop" checkbox checked]
13+
6. Once this is complete, verify that it shows up in [Maven Central](https://repo1.maven.org/maven2/com/newrelic/opentracing/java-aws-lambda/) or the [public facing version of the site](https://search.maven.org/search?q=a:java-aws-lambda). Note: This may take awhile, potentially up to a couple of hours, and it's likely that it will show up in Maven Central first. Additionally, https://mvnrepository.com/ is not directly associated with sonatype, and it may take days to show up there, so don't worry if it doesn't.
14+
7. A release should automatically be created on the [project's repo](https://github.com/newrelic/java-aws-lambda/releases). Select the latest release by clicking on the version number and update it to include any relevant release notes (bug fixes, improvements, notes).
15+
16+
## Post Release
17+
The newly released artifact should be incorporated into an existing project to validate that it functions as expected.
18+
19+
Submit and merge a PR with the following:
20+
- Update the `Usage` example in the README with the newly released version (e.g. `compile com.newrelic.opentracing:java-aws-lambda:2.0.0`).
21+
- Update the [gradle.properties](gradle.properties) file with a snapshot of the next version to be released (e.g. `version = 2.1.0-SNAPSHOT`).
22+
- Update the Github release with details of the new release.

gradle.properties

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,2 @@
11
group = com.newrelic.opentracing
2-
version = 2.0.0
3-
4-
5-
2+
version = 2.1.0-SNAPSHOT

0 commit comments

Comments
 (0)