xref: /aosp_15_r20/external/google-cloud-java/.kokoro/release/publish_javadoc11.sh (revision 55e87721aa1bc457b326496a7ca40f3ea1a63287)

#!/bin/bash
# Copyright 2022 Google LLC
#
# 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
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# 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

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

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

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

root_dir=$(pwd)

python3 --version

# install docuploader package
python3 -m pip install --require-hashes -r .kokoro/requirements.txt

# If DOCLET_VERSION is passed in (overriding version in shared-config)
if [ -n "${DOCLET_VERSION}" ]; then
  doclet_name="java-docfx-doclet-${DOCLET_VERSION}.jar"
fi

mvn -B -ntp \
  -DtrimStackTrace=false \
  -Dclirr.skip=true \
  -Dorg.slf4j.simpleLogger.showDateTime=true -Dorg.slf4j.simpleLogger.dateTimeFormat=HH:mm:ss:SSS \
  -Denforcer.skip=true \
  -Dcheckstyle.skip=true \
  -Dflatten.skip=true \
  -Danimal.sniffer.skip=true \
  -DskipTests=true \
  -Djacoco.skip=true \
  -T 1C \
  install

if [[ -z "${MODULE_LIST}" ]]; then
  # Retrieve list of modules from aggregator pom
  modules=($(mvn help:evaluate -Dexpression=project.modules | grep '<.*>.*</.*>' | sed -e 's/<.*>\(.*\)<\/.*>/\1/g'))
else
  modules=($(echo "${MODULE_LIST}" | tr ',' ' '))
fi
excluded_modules=('gapic-libraries-bom' 'google-cloud-jar-parent' 'google-cloud-pom-parent' 'java-shared-dependencies')
# TODO: Maps docs exclusion logic to be removed once we move to correct location on devsite. See b/262712184 and b/262600829
while IFS=  read -r -d $'\0'; do
    excluded_modules+=("$REPLY")
done < <(find java-maps-* -type d -maxdepth 0 -print0)
echo "Excluded modules: ${excluded_modules[*]}"
failed_modules=()

for module in "${modules[@]}"; do
  # Proceed if module is not excluded
  # Spaces are intentionally added -- Query is regex and array elements are space separated
  # It tries to match the *exact* `module` text
  if [[ ! " ${excluded_modules[*]} " =~ " ${module} " ]]; then
    pushd $module
    # Extract Cloud RAD module name from `distribution_name` in .repo-metadata.json
    NAME=$(grep -o '"distribution_name": "[^"]*' .repo-metadata.json | grep -o '[^"]*$' | cut -d ':' -f 2)
    # Extract (current) version from root `versions.txt` file and remove `-SNAPSHOT`
    VERSION=$(grep "^${NAME}:" "${root_dir}/versions.txt" | cut -d: -f3 | sed -e 's/-SNAPSHOT//g')
    echo "Running for ${NAME}-${VERSION}"

    # Cloud RAD generation
    if [ -z "${doclet_name}" ]; then
      mvn clean -B -ntp \
        -P docFX \
        -Dclirr.skip=true \
        -Denforcer.skip=true \
        -Dorg.slf4j.simpleLogger.showDateTime=true -Dorg.slf4j.simpleLogger.dateTimeFormat=HH:mm:ss:SSS \
        -Dcheckstyle.skip=true \
        -Dflatten.skip=true \
        -Danimal.sniffer.skip=true \
        javadoc:aggregate
    else
      mvn clean -B -ntp \
        -P docFX \
        -DdocletPath=${KOKORO_GFILE_DIR}/${doclet_name} \
        -Dclirr.skip=true \
        -Denforcer.skip=true \
        -Dorg.slf4j.simpleLogger.showDateTime=true -Dorg.slf4j.simpleLogger.dateTimeFormat=HH:mm:ss:SSS \
        -Dcheckstyle.skip=true \
        -Dflatten.skip=true \
        -Danimal.sniffer.skip=true \
        javadoc:aggregate
    fi

    if [ "$?" -ne "0" ]; then
      failed_modules+=("${module}")
      continue
    fi
    # include CHANGELOG if exists
    if [ -e CHANGELOG.md ]; then
      cp CHANGELOG.md target/docfx-yml/history.md
    fi
    pushd target/docfx-yml

    echo "Creating metadata for ${module}..."
    # create metadata
    python3 -m docuploader create-metadata \
      --name ${NAME} \
      --version ${VERSION} \
      --xrefs devsite://java/gax \
      --xrefs devsite://java/google-cloud-core \
      --xrefs devsite://java/api-common \
      --xrefs devsite://java/proto-google-common-protos \
      --xrefs devsite://java/google-api-client \
      --xrefs devsite://java/google-http-client \
      --xrefs devsite://java/protobuf \
      --language java

    echo "Uploading tarball for ${module}..."
    # upload yml to production bucket
    python3 -m docuploader upload . \
      --credentials ${CREDENTIALS} \
      --staging-bucket ${STAGING_BUCKET_V2} \
      --destination-prefix docfx

    echo "Uploaded tarball for ${module}"

    popd # out of target/docfx-yml
    popd # out of $module
  fi
done

if [ ${#failed_modules[@]} -eq 0 ]; then
  echo "All modules uploaded to CloudRAD"
else
  echo "These modules failed: ${failed_modules[*]}"
  exit 1
fi