Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Javadoc publish kokoro job uses docpublisher #243

Merged
merged 5 commits into from
May 28, 2019
Merged

Javadoc publish kokoro job uses docpublisher #243

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bb44a35
Javadoc publish kokoro job uses docpublisher
chingor13 Apr 23, 2019
28d08eb
Fix config path
chingor13 Apr 23, 2019
acc28fa
Fix site:stage config
chingor13 Apr 23, 2019
b6ad831
Move config to reporting
chingor13 Apr 23, 2019
3a1a054
Fix indent
chingor13 Apr 23, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions .kokoro/release/publish_javadoc.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
# Format: //devtools/kokoro/config/proto/build.proto

env_vars: {
key: "TRAMPOLINE_BUILD_FILE"
value: "github/google-auth-library-java/.kokoro/release/publish_javadoc.sh"
key: "STAGING_BUCKET"
value: "docs-staging"
}

env_vars: {
key: "LINK_LATEST"
value: "true"
key: "TRAMPOLINE_BUILD_FILE"
value: "github/google-auth-library-java/.kokoro/release/publish_javadoc.sh"
}

env_vars: {
key: "BUCKET"
value: "gcloud-javadoc-testing"
before_action {
fetch_keystore {
keystore_resource {
keystore_config_id: 73713
keyname: "docuploader_service_account"
}
}
}
88 changes: 39 additions & 49 deletions .kokoro/release/publish_javadoc.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,65 +1,55 @@
#!/bin/bash
# Copyright 2018, Google Inc. All rights reserved.
# Copyright 2019 Google Inc.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above
# copyright notice, this list of conditions and the following disclaimer
# in the documentation and/or other materials provided with the
# distribution.
# http://www.apache.org/licenses/LICENSE-2.0
#
# * Neither the name of Google Inc. nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

set -eo pipefail

set -e
if [[ -z "${CREDENTIALS}" ]]; then
CREDENTIALS=${KOKORO_KEYSTORE_DIR}/73713_docuploader_service_account
fi

if [[ -z "${BUCKET}" ]]; then
echo "Must set BUCKET environment variable"
exit 1
if [[ -z "${STAGING_BUCKET}" ]]; then
echo "Need to set STAGING_BUCKET environment variable"
exit 1
fi

# work from the git root directory
pushd $(dirname "$0")/../../

# Pull the library version from project properties
VERSION=$(mvn org.apache.maven.plugins:maven-help-plugin:2.1.1:evaluate -Dexpression=project.version | grep -Ev '(^\[|\w+:)')
# install docuploader package
python3 -m pip install gcp-docuploader

case "${VERSION}" in
*-SNAPSHOT)
echo "Cannot publish javadoc for -SNAPSHOT versions"
exit 1
;;
"")
echo "Could not obtain version number from maven-help-plugin."
exit 1
;;
esac
# compile all packages
mvn clean install -B -DskipTests=true

# Generate the javadoc from scratch
mvn clean install javadoc:aggregate -DskipTests=true -B
NAME=google-auth-library
VERSION=$(grep ${NAME}: versions.txt | cut -d: -f3)

# Sync the current version to gCS
gsutil -m rsync -d target/site gs://${BUCKET}/java/google-auth-library-java/${VERSION}
# build the docs
mvn site -B

if [[ "${LINK_LATEST}" == "true" ]]; then
# Sync the current content to latest
gsutil -m rsync gs://${BUCKET}/java/google-auth-library-java/${VERSION} gs://${BUCKET}/java/google-auth-library-java/latest
fi
pushd target/site/apidocs

# create metadata
python3 -m docuploader create-metadata \
--name ${NAME} \
--version ${VERSION} \
--language java

# upload docs
python3 -m docuploader upload . \
--credentials ${CREDENTIALS} \
--staging-bucket ${STAGING_BUCKET}

popd
1 change: 0 additions & 1 deletion appengine/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,5 +76,4 @@
<scope>test</scope>
</dependency>
</dependencies>

</project>
93 changes: 88 additions & 5 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@
authorization to enable calling Google APIs.</description>
<url>https://github.com/googleapis/google-auth-library-java</url>

<distributionManagement>
<site>
<id>googleapis.dev</id>
<name>Google self-hosted documentation site</name>
<url>https://googleapis.dev/java/google-auth-library/${project.version}</url>
</site>
</distributionManagement>

<licenses>
<license>
<name>BSD New license</name>
Expand Down Expand Up @@ -139,7 +147,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9.1</version>
<version>3.1.0</version>
<executions>
<execution>
<id>attach-javadocs</id>
Expand Down Expand Up @@ -190,10 +198,6 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
Expand All @@ -217,6 +221,14 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>3.7.1</version>
<configuration>
<skipDeploy>true</skipDeploy>
</configuration>
</plugin>
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
Expand All @@ -239,6 +251,51 @@
</plugins>
</build>

<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.1.0</version>
<reportSets>
<reportSet>
<id>html</id>
<reports>
<report>aggregate</report>
<report>javadoc</report>
</reports>
</reportSet>
</reportSets>
<configuration>
<doclint>none</doclint>
<source>7</source>
<outputDirectory>${project.build.directory}/javadoc</outputDirectory>
<doctitle>Google Auth Library for Java ${project.version}</doctitle>
<overview>${basedir}/overview.html</overview>
<groups>
<group>
<title>google-auth-library-credentials</title>
<packages>com.google.auth*</packages>
</group>
<group>
<title>google-auth-library-oauth2-http</title>
<packages>com.google.auth.http*:com.google.auth.oauth2*</packages>
</group>
<group>
<title>google-auth-library-appengine</title>
<packages>com.google.auth.appengine*</packages>
</group>
</groups>
<links>
<link>http://download.oracle.com/javase/7/docs/api/</link>
<link>http://cloud.google.com/appengine/docs/java/javadoc</link>
</links>
<windowtitle>google-auth-library ${project.version}</windowtitle>
</configuration>
</plugin>
</plugins>
</reporting>

<profiles>
<profile>
<id>release-sign-artifacts</id>
Expand All @@ -250,6 +307,32 @@
</activation>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>3.0.1</version>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar-no-fork</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.1.0</version>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
Expand Down
1 change: 1 addition & 0 deletions versions.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Format:
# module:released-version:current-version

google-auth-library:0.15.0:0.15.1-SNAPSHOT
google-auth-library-parent:0.15.0:0.15.1-SNAPSHOT
google-auth-library-appengine:0.15.0:0.15.1-SNAPSHOT
google-auth-library-credentials:0.15.0:0.15.1-SNAPSHOT
Expand Down