Skip to content

Commit a19c2fc

Browse files
Address PR feedback
1 parent 5ec4fdc commit a19c2fc

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

RELEASING.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
One-time setup
2+
==============
3+
14
Set up Sonatype Account
25
-----------------------
36
* Sign up for a Sonatype JIRA account [here](https://issues.sonatype.org)
@@ -66,7 +69,7 @@ Create a Maven settings file
6669
```
6770

6871
To push a release version
69-
-------------------------
72+
=========================
7073

7174
1. Make sure the team agrees that it is time to release.
7275

@@ -94,7 +97,7 @@ This script builds and stages the release artifact on the Maven Central Reposito
9497
If you experience failures, you may need to:
9598
- repeat the clean step above
9699
- remove the temporary directory created to store docs by running `rm -rf tmp_gh-pages`
97-
- remove staged repositories from Sonatype: if a staged repository appears [here](https://oss.sonatype.org/#nexus-search;quick~com.google.cloud), remove it by running `mvn nexus-staging:drop`.
100+
- remove staged repositories from Sonatype (to prevent them from being released in subsequent steps): if a staged repository appears [here](https://oss.sonatype.org/#nexus-search;quick~com.google.cloud), remove it by running `mvn nexus-staging:drop`.
98101

99102
6. Run `utilities/finalize_release.sh`.
100103
This script will release the staged artifact on the Maven Central Repository and push the README.md and gh-pages updates to github.
@@ -113,11 +116,11 @@ Go to the [releases page](https://github.com/GoogleCloudPlatform/google-cloud-ja
113116
9. Create and merge in another PR to reflect the updated project version. For an example of what this PR should look like, see [#227](https://github.com/GoogleCloudPlatform/google-cloud-java/pull/227).
114117

115118
To push a snapshot version
116-
--------------------------
119+
==========================
117120

118121
Pushing a snapshot is completely automated. If "-SNAPSHOT" is included in the version denoted by the base directory's pom.xml, then an updated artifact will be pushed to the snapshot repository when Travis CI successfully completes a non-PR build. The build triggers the `after_success.sh` script, which handles the release process for SNAPSHOT versions.
119122

120123
Improvements
121-
------------
124+
============
122125

123126
Automatic tagging is not currently implemented, though it was discussed in [#119](https://github.com/GoogleCloudPlatform/google-cloud-java/pull/119). If the version updates continue to be manual, a one-line git tag command can be added to `after_success.sh` to correctly tag releases. However, automatically creating useful annotations for this tag will be difficult. Also, if the release process becomes fully automated, tagging becomes a harder problem, as mentioned in that issue.

0 commit comments

Comments
 (0)