run_typedoc.sh

#!/bin/bash

# Runs typedoc on various Pulumi repos and copies them to
# the /libraries folder.

# NOTE: typedoc needs to be installed globally (see README.md) rather than
# in a local node_modules folder. This is because typedoc does not correctly
# support relative paths within a TypeScript file. (So, you can point it at a folder,
# but if those .ts files use a path like "..\", typedoc will fail to resolve as intended.)

set -o errexit -o pipefail

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"

TOOL_TYPEDOC="$SCRIPT_DIR/../node_modules/.bin/typedoc"
TOOL_TYPEDOC_CONFIG="$SCRIPT_DIR/../typedoc.json"

OUTDIR="${SCRIPT_DIR}/../static-prebuilt/docs/reference/pkg/nodejs/pulumi"

# Set this to 1 to run all generation in parallel.
PARALLEL=0

# Generates API documentation for a given package. The arguments are:
#     * $1 - the simple name of the package (e.g., "azure" for the pulumi-azure package)
#     * $2 - the typescript entry point file for the package, relative to the source directory, usually index.ts.
#     * $3 - the package root directory (to run `make ensure` for dependency updates)
#     * $4 - the package source directory, relative to the root, optionally empty if the same
# If the PKGS envvar is set, only packages in that list (space delimited) are regenerated.
generate_docs() {
    GENPKG=""
    if [[ -z "$PKGS" ]]; then
        GENPKG=$1
    else
        for PKG in ${PKGS}; do
            if [[ "$PKG" == "$1" ]]; then
                GENPKG=$1
            fi
        done
    fi

    if [[ ! -z "$GENPKG" ]]; then
        echo -e "\033[0;95m$1\033[0m"
        echo -e "\033[0;93mGenerating pulumi.com API docs\033[0m"

        # Change to the target directory and rebuild if necessary.
        PKGPATH=../$3
        pushd $PKGPATH
        if [[ -z "$NOBUILD" ]]; then
            git clean -xdf
            make ensure && make build && make install
        fi
        if [[ ! -z "$4" ]]; then
            PKGPATH=$PKGPATH/$4
            cd $4
        fi

        PKG_REPO_DIR=$3
        if [[ ! -z "$4" ]]; then
        PKG_REPO_DIR=$PKG_REPO_DIR/$4
        fi

        ${TOOL_TYPEDOC} --out "${OUTDIR}/$1" \
            --excludeInternal --excludeExternals --excludePrivate \
            --cleanOutputDir \
            --skipErrorChecking \
            --plugin typedoc-plugin-script-inject \
            --options "$TOOL_TYPEDOC_CONFIG" \
            "$2"

        popd
    fi
}

REPOS=(
    "awsx,index.ts,pulumi-awsx/sdk/nodejs"
    "cloud,types.ts,pulumi-cloud/api"
    "kubernetesx,index.ts,pulumi-kubernetesx/nodejs/kubernetesx"
    "policy,index.ts,pulumi-policy,sdk/nodejs/policy"
    "pulumi,index.ts,pulumi/sdk/nodejs"
    "terraform,index.ts,pulumi-terraform,sdk/nodejs"
    "esc-sdk,index.ts,esc-sdk/sdk/typescript/esc"
)

PIDS=()

# run processes and store pids in array
for repo in ${REPOS[*]}
do
    IFS=',' read -r -a repo_parts <<< "$repo"
    SIMPLE_NAME=${repo_parts[0]}
    ENTRY_POINT=${repo_parts[1]}
    PACKAGE_NAME=${repo_parts[2]}
    ROOT_PATH=${repo_parts[3]}
    if [ "$PARALLEL" -eq "1" ]; then
        generate_docs $SIMPLE_NAME $ENTRY_POINT $PACKAGE_NAME $ROOT_PATH &
        PIDS+=($!)
    else
        generate_docs $SIMPLE_NAME $ENTRY_POINT $PACKAGE_NAME $ROOT_PATH
        PIDS+=($!)
    fi
    echo -e $!
done

# wait for all pids
for pid in ${PIDS[*]}
do
    echo -e "Waiting on: $pid"
    wait $pid
done

echo "Done"