You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It also works just as well to declare a dependency only on the specific clients that you need. See the README of
75
73
each client for instructions.
@@ -177,7 +175,7 @@ Credentials in the following locations (in order):
177
175
Troubleshooting
178
176
---------------
179
177
180
-
To get help, follow the instructions in the [Troubleshooting document](https://github.com/GoogleCloudPlatform/google-cloud-java/blob/master/TROUBLESHOOTING.md).
178
+
To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/GoogleCloudPlatform/gcloud-common/blob/master/troubleshooting/readme.md#troubleshooting).
181
179
182
180
Using a proxy
183
181
-------------
@@ -270,29 +268,26 @@ we're working towards their release candidate. We will address issues and reques
270
268
a higher priority.
271
269
272
270
**Alpha**: Libraries defined at an Alpha quality level are still a work-in-progress and
273
-
are more likely to get backwards-incompatible updates. Additionally, it's possible for Alpha
274
-
libraries to get deprecated and deleted before ever being promoted to Beta or GA.
271
+
are more likely to get backwards-incompatible updates.
275
272
276
273
Version Management
277
274
------------------
278
275
279
276
The easiest way to solve version conflicts is to use google-cloud's BOM. In Maven, add the following to your POM:
Copy file name to clipboardExpand all lines: trunk/RELEASING.md
+10-11Lines changed: 10 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -78,42 +78,41 @@ To push a release version
78
78
79
79
3. Verify that all unit and integration tests for the last commit have passed.
80
80
81
-
4. Run `python utilities/bump_versions.py next_release minor` from the repository's base directory. (If there are only bug fixes and no additions to the surface, use `patch` instead of `minor`.) Alternatively, update the versions in `versions.txt` to the correct versions for the next release.
82
-
83
-
5. Run `python utilities/replace_versions.py` from the repository's base directory. This updates the versions in all `pom.xml` and `README.md` files in preparation for a release. Commit these files locally:
81
+
4. Run `utilities/update_versions.sh` from the repository's base directory.
82
+
This script takes optional arguments denoting the new versions for each qualifier (alpha, beta and/or GA). By default, if the current version is X.Y.Z-SNAPSHOT, the script will update the version in all the pom.xml and other relevant files to X.Y.Z. Please refer to the documentation in `utilities/update_versions.sh` for more details. Commit this version locally:
84
83
85
84
```
86
85
git add .
87
86
git commit -m "Release [VERSION HERE]"
88
87
```
89
88
90
-
6. Make sure you are using Maven version 3.3 or higher to support the Nexus plugin required to stage a release.
89
+
1. Make sure you are using Maven version 3.3 or higher to support the Nexus plugin required to stage a release.
91
90
92
-
7. To ensure a clean build, remove *all* Maven targets (including subdirectories not handled by `mvn clean`) by running `rm -rf target */target`.
91
+
1. To ensure a clean build, remove *all* Maven targets (including subdirectories not handled by `mvn clean`) by running `rm -rf target */target`.
93
92
94
-
8. Run `utilities/stage_release.sh`.
93
+
5. Run `utilities/stage_release.sh`.
95
94
This script builds and stages the release artifact on the Maven Central Repository, updates the README.md files with the release version + commits them locally, and finally generates a new site version for the gh-pages branch under a temporary directory named `tmp_gh-pages`. If you haven't run the release process before, it's worth verifying everything; check the staged release on the Sonatype website, and verify that the local commits have the right version updates.
96
95
97
96
If you experience failures, you may need to:
98
97
- repeat the clean step above
99
98
- remove the temporary directory created to store docs by running `rm -rf tmp_gh-pages`
100
99
- 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`.
101
100
102
-
9. Run `utilities/finalize_release.sh`.
101
+
6. Run `utilities/finalize_release.sh`.
103
102
This script will release the staged artifact on the Maven Central Repository and push the README.md and gh-pages updates to github.
104
103
105
-
10. Publish a release on Github manually.
104
+
7. Publish a release on Github manually.
106
105
Go to the [releases page](https://github.com/GoogleCloudPlatform/google-cloud-java/releases) and open the appropriate release draft. Make sure the "Tag Version" is `vX.Y.Z` and the "Release Title" is `X.Y.Z`, where `X.Y.Z` is the release version as listed in the `pom.xml` files.
107
106
108
107
Add the commits since the last release into the release draft. Try to group them into sections with related changes. Anything that is a breaking change needs to be marked with `*breaking change*`. Such changes are only allowed for alpha/beta modules and `@BetaApi` features.
109
108
110
109
Ensure that the format is consistent with previous releases (for an example, see the [0.1.0 release](https://github.com/GoogleCloudPlatform/google-cloud-java/releases/tag/v0.1.0)). After adding any missing updates and reformatting as necessary, publish the draft.
111
110
112
-
11. Create a new draft for the next release. Note any commits not included in the release that have been submitted before the release commit, to ensure they are documented in the next release.
111
+
1. Create a new draft for the next release. Note any commits not included in the release that have been submitted before the release commit, to ensure they are documented in the next release.
113
112
114
-
12. Run `python utilities/bump_versions next_snapshot patch`to include "-SNAPSHOT" in the current project version (Alternatively, update the versions in `versions.txt` to the correct versions for the next release.). Then, run `python utilities/replace_versions.py`to update the `pom.xml` files. (If you see updates in `README.md` files at this step, you probably did something wrong.)
113
+
8. Run `utilities/update_versions.sh` again (to include "-SNAPSHOT" in the project version). Please refer to documentation in `utilities/update_versions.sh` for more details.
115
114
116
-
13. 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).
115
+
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).
0 commit comments