build-package-docs.sh

#!/bin/bash
# build-package-docs.sh updates the docs generated from the indicated repo.
#
# Note that if PULUMI_BOT_GITHUB_API_TOKEN is unset, this script will fail. If this happens, the doc build can be run
# manually by triggering a job using the following steps:
# - Under "More options" in the Travis UI, choose "Trigger build"
# - Under "Branch", enter the name of the tag for the latest release
# - Under "Custom Config", enter the following:
#
#     if: branch = [TAG]
#     script: make build install && $(go env GOPATH)/src/github.com/pulumi/scripts/ci/build-package-docs.sh [PACKAGE SIMPLE NAME]
#     env:
#         - TRAVIS_TAG=[TAG]
#
# - Finally, select "Trigger custom build". The triggered job will regenerate the docs using this script and publish
#   the expected PR.
set -o nounset
set -o errexit
set -o pipefail

if [[ "${TRAVIS:-}" != "true" ]]; then
    echo "error: this script should be run from within Travis"
    exit 1
fi

if [[ -z "${PULUMI_BOT_GITHUB_API_TOKEN:-}" ]]; then
    echo "error: PULUMI_BOT_GITHUB_API_TOKEN must be set"
    exit 1
fi

if [[ -z "${1:-}" ]]; then
    echo "Usage: $0 <package-simple-name>"
    exit 1
fi

if ! echo "${TRAVIS_TAG:-}" | grep -q -e "^v[0-9]\+\.[0-9]\+\.[0-9]\+$"; then
    echo "Skipping documentation generation; ${TRAVIS_TAG:-} does not denote a released version"
    exit 0
fi

PKG_NAME="$1"
VERSION=${TRAVIS_TAG#"v"}

echo "Building SDK docs for version ${VERSION}:"

# Clone the docs repo and fetch its dependencies, since the bits necessary for
# generating documentation are found there. (Specifically docs/tools/resourcedocsgen; which
# has some overrides in the go.mod file that expect code from pulumi/pulumi to be local.)
if [[ ! -d "$(go env GOPATH)/src/github.com/pulumi/pulumi" ]]; then
    git clone "https://github.com/pulumi/pulumi.git" "$(go env GOPATH)/src/github.com/pulumi/pulumi"
fi
git clone "https://github.com/pulumi/docs.git" "$(go env GOPATH)/src/github.com/pulumi/docs"

cd "$(go env GOPATH)/src/github.com/pulumi/docs"
make ensure ensure_tools

go get -u github.com/cbroglie/mustache
go get -u github.com/gobuffalo/packr
go get -u github.com/pkg/errors

# Regenerate the Node.JS SDK docs
PKGS=${PKG_NAME} NOBUILD=true ./scripts/run_typedoc.sh

# Regenerate the resource docs (for the specific plugin version) if applicable.
case ${PKG_NAME} in
    "pulumi" | "policy" | "policy-aws")
        echo "Skipping gen_resource_docs step because package doesn't contain any resources."
        ;;
    "awsx" | "eks" | "kubernetesx" | "terraform")
        # gen_resource_docs.sh assumes the package has a `make generate_schema` step.
        echo "Skipping gen_resource_docs step because package hasn't been schematized yet."
        ;;
    *)
        ./scripts/gen_resource_docs.sh "${PKG_NAME}" true "v${VERSION}"
        ;;
esac

# Regenerate the Python docs
case ${PKG_NAME} in
    "awsx" | "eks" | "kubernetesx" | "terraform" | "policy-aws")
        echo "Skipping generate_python_docs step because package is not available in Python."
        ;;
    *)
        ./scripts/generate_python_docs.sh "${PKG_NAME}"
        ;;
esac

if [[ "${PKG_NAME}" == "pulumi" ]]; then
    # Regenerate the CLI docs
    pulumi gen-markdown ./content/docs/reference/cli

    # Update latest-version
    echo -n "${VERSION}" > ./static/latest-version

    # Update the version list
    NL=$'\n'
    sed -e "s/<tbody>/<tbody>\\${NL}        {{< changelog-table-row version=\"${VERSION}\" date=\"$(date +%Y-%m-%d)\" >}}/" -i ./content/docs/get-started/install/versions.md
fi

# Commit the resulting changes
BRANCH="${PKG_NAME}/${TRAVIS_JOB_NUMBER}"
MESSAGE="Regen docs for ${PKG_NAME}@${VERSION}"

git checkout -b "${BRANCH}"
git config user.name "Pulumi Bot"
git config user.email "bot@pulumi.com"
git add .
git commit --allow-empty -m "${MESSAGE}"

# Push up the resulting changes
git remote add pulumi-bot "https://pulumi-bot:${PULUMI_BOT_GITHUB_API_TOKEN}@github.com/pulumi-bot/docs"
git push pulumi-bot --set-upstream --force "${BRANCH}"

# Create a pull request in the docs repo.
BODY="{\"title\": \"${MESSAGE}\", \"head\": \"pulumi-bot:${BRANCH}\", \"base\": \"master\"}"
curl -u "pulumi-bot:${PULUMI_BOT_GITHUB_API_TOKEN}" -X POST -H "Content-Type: application/json" -d "${BODY}" "https://api.github.com/repos/pulumi/docs/pulls"

exit 0