Skip to content

Commit

Permalink
Post-release cleanup and fixes (specific to recent repository restruc…
Browse files Browse the repository at this point in the history
…ture) (#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)
  • Loading branch information
vam-google authored May 21, 2018
1 parent b638435 commit 94a4b56
Show file tree
Hide file tree
Showing 41 changed files with 118 additions and 97 deletions.
21 changes: 9 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ This library supports the following Google Cloud Platform services with clients
- [Cloud Video Intelligence](google-cloud-clients/google-cloud-video-intelligence) (Beta)
- [Stackdriver Trace](google-cloud-clients/google-cloud-trace) (Beta)
- [Text-to-Speech](google-cloud-clients/google-cloud-texttospeech) (Beta)
- [IoT](google-cloud-clients/google-cloud-iot) (Beta)

This library supports the following Google Cloud Platform services with clients at an [Alpha](#versioning) quality level:

Expand All @@ -43,6 +44,7 @@ This library supports the following Google Cloud Platform services with clients
- [Cloud Resource Manager](google-cloud-clients/google-cloud-resourcemanager) (Alpha)
- [Cloud Speech](google-cloud-clients/google-cloud-speech) (Alpha)
- [Dialogflow](google-cloud-clients/google-cloud-dialogflow) (Alpha)
- [Web Security Scanner](google-cloud-clients/google-cloud-websecurityscanner) (Alpha)

These libraries are deprecated and no longer receive updates:

Expand All @@ -51,32 +53,27 @@ These libraries are deprecated and no longer receive updates:
Quickstart
----------

The easy way to get started is to add the umbrella package which pulls in all of the supported clients as
dependencies. Note that even though the version of the umbrella package is Alpha, the individual clients are
at different support levels (Alpha, Beta, and GA).
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).

[//]: # ({x-version-update-start:google-cloud:released})
[//]: # ({x-version-update-start:google-cloud-storage:released})
If you are using Maven, add this to your pom.xml file
```xml
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud</artifactId>
<version>0.48.0-alpha</version>
<artifactId>google-cloud-storage</artifactId>
<version>1.30.0</version>
</dependency>
```
If you are using Gradle, add this to your dependencies
```Groovy
compile 'com.google.cloud:google-cloud:0.48.0-alpha'
compile 'com.google.cloud:google-cloud-storage:1.30.0'
```
If you are using SBT, add this to your dependencies
```Scala
libraryDependencies += "com.google.cloud" % "google-cloud" % "0.48.0-alpha"
libraryDependencies += "com.google.cloud" % "google-cloud-storage" % "1.30.0"
```
[//]: # ({x-version-update-end})

It also works just as well to declare a dependency only on the specific clients that you need. See the README of
each client for instructions.

If you're using IntelliJ or Eclipse, you can add client libraries to your project using these IDE plugins:
* [Cloud Tools for IntelliJ](https://cloud.google.com/tools/intellij/docs/client-libraries)
* [Cloud Tools for Eclipse](https://cloud.google.com/eclipse/docs/libraries)
Expand Down Expand Up @@ -361,4 +358,4 @@ Apache 2.0 - See [LICENSE] for more information.
[cloud-platform]: https://cloud.google.com/
[cloud-platform-docs]: https://cloud.google.com/docs/
[client-lib-docs]: http://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/
[client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/google-cloud-clients/apidocs/index.html
22 changes: 11 additions & 11 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,27 +91,27 @@ To push a release version

7. To ensure a clean build, remove *all* Maven targets (including subdirectories not handled by `mvn clean`) by running `rm -rf target */target`.

8. Run `utilities/stage_release.sh`.
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.
8. Run `python utilities/stage_sites.py`.
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.

If you experience failures, you may need to:
- repeat the clean step above
- remove the temporary directory created to store docs by running `rm -rf tmp_gh-pages`
- 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`.
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.

9. Run `utilities/finalize_release.sh`.
This script will release the staged artifact on the Maven Central Repository and push the README.md and gh-pages updates to github.
10. Run `mvn nexus-staging:release` to release the artifacts.

10. Publish a release on Github manually.
11. Run `cd tmp_gh-pages && git push && cd ..` to push the previously generated docs (step 8).

12. Run `rm -rf tmp_gh-pages` to remove the generated docs directory from your local machine.

13. Publish a release on Github manually.
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.

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.

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.

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

13. Create and merge in another PR to reflect the updated project version.
15. Create and merge in another PR to reflect the updated project version.

Improvements
============
Expand Down
13 changes: 13 additions & 0 deletions google-api-grpc/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -686,6 +686,19 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.3</version>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
Expand Down
2 changes: 1 addition & 1 deletion google-cloud-clients/google-cloud-bigquery/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,4 +245,4 @@ Apache 2.0 - See [LICENSE] for more information.
[cloud-bigquery]: https://cloud.google.com/bigquery/
[cloud-storage]: https://cloud.google.com/storage/
[bigquery-product-docs]: https://cloud.google.com/bigquery/docs/
[bigquery-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/index.html?com/google/cloud/bigquery/package-summary.html
[bigquery-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/google-cloud-clients/apidocs/index.html?com/google/cloud/bigquery/package-summary.html
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,4 @@ Apache 2.0 - See [LICENSE] for more information.

[cloud-bigquerydatatransfer]: https://cloud.google.com/bigquery/docs/transfer-service-overview
[bigquerydatatransfer-product-docs]: https://cloud.google.com/bigquery/docs/transfer-service-overview
[bigquerydatatransfer-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/index.html?com/google/cloud/bigquerydatatransfer/v1/package-summary.html
[bigquerydatatransfer-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/google-cloud-clients/apidocs/index.html?com/google/cloud/bigquery/datatransfer/v1/package-summary.html
2 changes: 1 addition & 1 deletion google-cloud-clients/google-cloud-bigtable/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,4 +171,4 @@ Apache 2.0 - See [LICENSE] for more information.
[cloud-platform]: https://cloud.google.com/
[cloud-bigtable]: https://cloud.google.com/bigtable/
[bigtable-product-docs]: https://cloud.google.com/bigtable/docs/
[bigtable-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/index.html?com/google/cloud/bigtable/package-summary.html
[bigtable-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/google-cloud-clients/apidocs/index.html?com/google/cloud/bigtable/package-summary.html
2 changes: 1 addition & 1 deletion google-cloud-clients/google-cloud-compute/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -276,4 +276,4 @@ Apache 2.0 - See [LICENSE] for more information.

[cloud-compute]: https://cloud.google.com/compute/
[compute-product-docs]: https://cloud.google.com/compute/docs/
[compute-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/index.html?com/google/cloud/compute/package-summary.html
[compute-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/google-cloud-clients/apidocs/index.html?com/google/cloud/compute/deprecated/package-summary.html
2 changes: 1 addition & 1 deletion google-cloud-clients/google-cloud-container/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,4 +117,4 @@ Apache 2.0 - See [LICENSE] for more information.
[cloud-container]: https://cloud.google.com/kubernetes-engine/
[cloud-container-quickstart]: https://cloud.google.com/kubernetes-engine/docs/quickstart
[container-product-docs]: https://cloud.google.com/kubernetes-engine/docs/
[container-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/index.html?com/google/cloud/container/v1/package-summary.html
[container-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/google-cloud-clients/apidocs/index.html?com/google/cloud/container/v1/package-summary.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Logback appender `com.google.cloud.logging.logback.LoggingAppender` for
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.

- [Homepage](https://googlecloudplatform.github.io/google-cloud-java/)
- [API Documentation](https://googlecloudplatform.github.io/google-cloud-java/apidocs/index.html?com/google/cloud/logging/logback/LoggingAppender.html)
- [API Documentation](https://googlecloudplatform.github.io/google-cloud-java/google-cloud-clients/apidocs/index.html?com/google/cloud/logging/logback/LoggingAppender.html)

> Note: This client is a work-in-progress, and may occasionally
> make backwards-incompatible changes.
Expand Down
2 changes: 1 addition & 1 deletion google-cloud-clients/google-cloud-dataproc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,5 +117,5 @@ Apache 2.0 - See [LICENSE] for more information.
[cloud-dataproc]: https://cloud.google.com/dataproc/
[cloud-dataproc-quickstart]: https://cloud.google.com/dataproc/quickstart-console#before-you-begin
[dataproc-product-docs]: https://cloud.google.com/dataproc/docs/
[dataproc-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/index.html?com/google/cloud/dataproc/v1/package-summary.html
[dataproc-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/google-cloud-clients/apidocs/index.html?com/google/cloud/dataproc/v1/package-summary.html
[auth]: https://cloud.google.com/docs/authentication/getting-started
4 changes: 2 additions & 2 deletions google-cloud-clients/google-cloud-datastore/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ libraryDependencies += "com.google.cloud" % "google-cloud-datastore" % "1.30.0"

Example Applications
--------------------
- [`DatastoreExample`](../google-cloud-examples/src/main/java/com/google/cloud/examples/datastore/DatastoreExample.java) is a simple command line interface for the Cloud Datastore. Read more about using the application on the [`DatastoreExample` docs page](https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/?com/google/cloud/examples/datastore/DatastoreExample.html).
- [`DatastoreExample`](../google-cloud-examples/src/main/java/com/google/cloud/examples/datastore/DatastoreExample.java) is a simple command line interface for the Cloud Datastore. Read more about using the application on the [`DatastoreExample` docs page](https://googlecloudplatform.github.io/google-cloud-java/google-cloud-clients/apidocs/?com/google/cloud/examples/datastore/DatastoreExample.html).
- [`Bookshelf`](https://github.com/GoogleCloudPlatform/getting-started-java/tree/master/bookshelf) - An App Engine app that manages a virtual bookshelf.
- This app uses `google-cloud` to interface with Cloud Datastore and Cloud Storage. It also uses Cloud SQL, another Google Cloud Platform service.
- [`Flexible Environment/Datastore example`](https://github.com/GoogleCloudPlatform/java-docs-samples/tree/master/flexible/datastore) - A simple app that uses Cloud Datastore to list the last 10 IP addresses that visited your site.
Expand Down Expand Up @@ -226,4 +226,4 @@ Apache 2.0 - See [LICENSE] for more information.
[cloud-datastore-activation]: https://cloud.google.com/datastore/docs/activate
[cloud-datastore]: https://cloud.google.com/datastore/
[datastore-product-docs]: https://cloud.google.com/datastore/docs/
[datastore-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/index.html?com/google/cloud/datastore/package-summary.html
[datastore-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/google-cloud-clients/apidocs/index.html?com/google/cloud/datastore/package-summary.html
2 changes: 1 addition & 1 deletion google-cloud-clients/google-cloud-dialogflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,4 @@ Apache 2.0 - See [LICENSE] for more information.
[dialogflow]: https://dialogflow.com/
[dialogflow-standard-product-docs]: https://dialogflow.com/docs
[dialogflow-enterprise-product-docs]: https://cloud.google.com/dialogflow-enterprise/docs/
[dialogflow-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/index.html?com/google/cloud/dialogflow/v2beta1/package-summary.html
[dialogflow-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/google-cloud-clients/apidocs/index.html?com/google/cloud/dialogflow/v2beta1/package-summary.html
2 changes: 1 addition & 1 deletion google-cloud-clients/google-cloud-dlp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,4 +103,4 @@ Apache 2.0 - See [LICENSE] for more information.
[cloud-platform]: https://cloud.google.com/
[cloud-dlp]: https://cloud.google.com/dlp/
[dlp-product-docs]: https://cloud.google.com/dlp/docs/
[dlp-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/index.html?com/google/cloud/dlp/v2beta1/package-summary.html
[dlp-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/google-cloud-clients/apidocs/index.html?com/google/cloud/dlp/v2/package-summary.html
2 changes: 1 addition & 1 deletion google-cloud-clients/google-cloud-dns/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -394,4 +394,4 @@ Apache 2.0 - See [LICENSE] for more information.
[cloud-dns]: https://cloud.google.com/dns/
[cloud-dns-activate]: https://cloud.google.com/dns/getting-started#prerequisites
[dns-product-docs]: https://cloud.google.com/dns/docs/
[dns-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/index.html?com/google/cloud/dns/package-summary.html
[dns-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/google-cloud-clients/apidocs/index.html?com/google/cloud/dns/package-summary.html
2 changes: 1 addition & 1 deletion google-cloud-clients/google-cloud-errorreporting/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,4 @@ Apache 2.0 - See [LICENSE] for more information.
[cloud-platform]: https://cloud.google.com/
[stackdriver-error-reporting]: https://cloud.google.com/error-reporting/
[error-reporting-product-docs]: https://cloud.google.com/error-reporting/docs/
[error-reporting-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/index.html?com/google/cloud/errorreporting/v1beta1/package-summary.html
[error-reporting-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/google-cloud-clients/apidocs/index.html?com/google/cloud/errorreporting/v1beta1/package-summary.html
2 changes: 1 addition & 1 deletion google-cloud-clients/google-cloud-firestore/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Google Cloud Java Client for Firestore


- [Product Documentation](https://cloud.google.com/firestore/docs/)
- [Client Library Documentation](https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/index.html?com/google/cloud/firestore/package-summary.html)
- [Client Library Documentation](https://googlecloudplatform.github.io/google-cloud-java/google-cloud-clients/apidocs/index.html?com/google/cloud/firestore/package-summary.html)

Quickstart
----------
Expand Down
2 changes: 1 addition & 1 deletion google-cloud-clients/google-cloud-iot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,4 +99,4 @@ Apache 2.0 - See [LICENSE] for more information.
[cloud-platform]: https://cloud.google.com/
[cloud-iot]: https://cloud.google.com/iot-core
[iot-product-docs]: https://cloud.google.com/iot-core/docs
[iot-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/index.html?com/google/cloud/iot/v1/package-summary.html
[iot-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/google-cloud-clients/apidocs/index.html?com/google/cloud/iot/v1/package-summary.html
2 changes: 1 addition & 1 deletion google-cloud-clients/google-cloud-language/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,4 +129,4 @@ Apache 2.0 - See [LICENSE] for more information.
[cloud-platform]: https://cloud.google.com/
[cloud-language]: https://cloud.google.com/natural-language/
[language-product-docs]: https://cloud.google.com/natural-language/docs/
[language-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/index.html?com/google/cloud/language/v1beta2/package-summary.html
[language-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/google-cloud-clients/apidocs/index.html?com/google/cloud/language/v1beta2/package-summary.html
2 changes: 1 addition & 1 deletion google-cloud-clients/google-cloud-logging/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,4 +229,4 @@ Apache 2.0 - See [LICENSE] for more information.
[stackdriver-logging]: https://cloud.google.com/logging/
[stackdriver-logging-quickstart]: https://cloud.google.com/logging/docs/quickstart-sdk
[logging-product-docs]: https://cloud.google.com/logging/docs/
[logging-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/index.html?com/google/cloud/logging/package-summary.html
[logging-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/google-cloud-clients/apidocs/index.html?com/google/cloud/logging/package-summary.html
2 changes: 1 addition & 1 deletion google-cloud-clients/google-cloud-monitoring/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,4 +99,4 @@ Apache 2.0 - See [LICENSE] for more information.
[cloud-platform]: https://cloud.google.com/
[stackdriver-monitoring]: https://cloud.google.com/monitoring/
[monitoring-product-docs]: https://cloud.google.com/monitoring/docs/
[monitoring-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/index.html?com/google/cloud/monitoring/v3/package-summary.html
[monitoring-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/google-cloud-clients/apidocs/index.html?com/google/cloud/monitoring/v3/package-summary.html
2 changes: 1 addition & 1 deletion google-cloud-clients/google-cloud-notification/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Google Cloud Java Client for Cloud Pub/Sub Notifications


- [Product Documentation](https://cloud.google.com/storage/docs/pubsub-notifications)
- [Client Library Documentation](https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/index.html?com/google/cloud/notification/package-summary.html)
- [Client Library Documentation](https://googlecloudplatform.github.io/google-cloud-java/google-cloud-clients/apidocs/index.html?com/google/cloud/notification/package-summary.html)

Quickstart
----------
Expand Down
Loading

0 comments on commit 94a4b56

Please sign in to comment.