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
Post-release cleanup and fixes (specific to recent repository restructure) (#3290)
1) Fix poms deployment config.
2) Fix documentaiton links in readmes.
3) Update main README (remove `goolge-cloud` metapackage reference).
4) Update `RELEASING.md` to reflect changes. The instructions try to avoid having mysterious scripts running in the release process and also ensures that all disruptive operations (actual release/push) are done explicitly and not somewhere in the middle of a mysterious script.
5) Remove `deploy.sh` and `finalize_release.sh` scripts.
6) Fix few previously broken links (bigquerydatatransfer and compute apidocs links)
These libraries are deprecated and no longer receive updates:
48
50
@@ -51,32 +53,27 @@ These libraries are deprecated and no longer receive updates:
51
53
Quickstart
52
54
----------
53
55
54
-
The easy way to get started is to add the umbrella package which pulls in all of the supported clients as
55
-
dependencies. Note that even though the version of the umbrella package is Alpha, the individual clients are
56
-
at different support levels (Alpha, Beta, and GA).
56
+
To call any of the supported Google Cloud Services simply add a corresponding client library artifact as a dependency to your project. The following instructions use `google-cloud-storage` as an example (specific instructions can be found in the README of each client).
It also works just as well to declare a dependency only on the specific clients that you need. See the README of
78
-
each client for instructions.
79
-
80
77
If you're using IntelliJ or Eclipse, you can add client libraries to your project using these IDE plugins:
81
78
*[Cloud Tools for IntelliJ](https://cloud.google.com/tools/intellij/docs/client-libraries)
82
79
*[Cloud Tools for Eclipse](https://cloud.google.com/eclipse/docs/libraries)
@@ -361,4 +358,4 @@ Apache 2.0 - See [LICENSE] for more information.
Copy file name to clipboardExpand all lines: RELEASING.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -91,27 +91,27 @@ To push a release version
91
91
92
92
7. To ensure a clean build, remove *all* Maven targets (including subdirectories not handled by `mvn clean`) by running `rm -rf target */target`.
93
93
94
-
8. Run `utilities/stage_release.sh`.
95
-
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.
94
+
8. Run `python utilities/stage_sites.py`.
95
+
This script checks out `gh-pages` branch of the repository, builds the documentation site and javadocs, copies them to the branch and commits it. This script does not push the docs and it must be done manually on the later step. The script assumes that there is no directory called `tmp_gh-pages` in the repository root, remove that directory, if exists, before running the script.
96
96
97
-
If you experience failures, you may need to:
98
-
- repeat the clean step above
99
-
- remove the temporary directory created to store docs by running `rm -rf tmp_gh-pages`
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`.
97
+
9. Check that you are not trying to release a SNAPSHOT build (the artifacts versions do not have "-SNAPSHOT" suffix) and then run `mvn clean deploy -DskipTests=true --settings ~/.m2/settings.xml -P release` command. It will build and deploy artifacts to the staging repository.
101
98
102
-
9. Run `utilities/finalize_release.sh`.
103
-
This script will release the staged artifact on the Maven Central Repository and push the README.md and gh-pages updates to github.
99
+
10. Run `mvn nexus-staging:release` to release the artifacts.
104
100
105
-
10. Publish a release on Github manually.
101
+
11. Run `cd tmp_gh-pages && git push && cd ..` to push the previously generated docs (step 8).
102
+
103
+
12. Run `rm -rf tmp_gh-pages` to remove the generated docs directory from your local machine.
104
+
105
+
13. Publish a release on Github manually.
106
106
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
107
108
108
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
109
110
110
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
111
112
-
11. Run `python utilities/bump_versions.py 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.)
112
+
14. Run `python utilities/bump_versions.py 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
113
114
-
13. Create and merge in another PR to reflect the updated project version.
114
+
15. Create and merge in another PR to reflect the updated project version.
Copy file name to clipboardExpand all lines: google-cloud-clients/google-cloud-contrib/google-cloud-logging-logback/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ Logback appender `com.google.cloud.logging.logback.LoggingAppender` for
7
7
This library allows you to use [Logback](https://logback.qos.ch/) configuration and the [Slf4j](https://www.slf4j.org/) interface to log via Google Cloud logging.
0 commit comments