generate.sh

#!/bin/bash
# (C) 2023 GoodData Corporation
set -e
shopt -s extglob

content_dir=versioned_docs
# Name of the remote hosting the main repo (gitlab.com/gooddata/gdc-tiger-docs)
remote_name=${1:-origin}
# target branch where changes will be applied (master, rel/0.7, ...)
target_branch=${2:-master}
# Number of the versions to persist. Older ones are accessible only from GitHub.
num_versions=${3:-4}

echo "Validating target branch '$target_branch'"
case "$target_branch" in
    master)
        current_section=""
        src_dir="."
        ;;
    rel/@(+([[:digit:]]).+([[:digit:]])|cloud))
        current_section="${target_branch#rel/}"
        src_dir="docs"
        ;;
    *)
        echo "Unsupported target branch '$target_branch'"
        exit 1
esac

REPO_ROOT="$(cd "$(dirname "$0")/.." && pwd)"

# TODO: update when we move hugo to repo root
pushd "$REPO_ROOT/docs"

rm -rf ${content_dir:?}/*

# Add upstream if it doesn't exist
if ! git config remote.upstream.url >/dev/null; then
  git remote add upstream https://github.com/gooddata/gooddata-python-sdk
else
  echo "Upstream already exists, skipping add."
fi

git fetch "$remote_name"


latest_branches=()
# Get all relevant rel/* branches, sort them, and pick the latest num_versions
while IFS= read -r vers; do
    latest_branches+=("$remote_name/rel/$vers")
done < <(git branch -rl "$remote_name/rel/*" | sed 's|.*/rel/||' | sort -t. -k1,1n -k2,2n | tail -n"$num_versions")

# Add special branches to the array (only rel/dev and master for now)
special_branches=("$remote_name/rel/dev" "$remote_name/master")

branches_to_process=("${latest_branches[@]}" "${special_branches[@]}")

echo "Branches to be processed:"
for branch in "${branches_to_process[@]}"; do
    echo "$branch"
done

# For every release branch, copy the docs to conetentDir/x.y
for branch in "${branches_to_process[@]}" ; do
    target_section=${branch#"$remote_name"/}
    target_section=${target_section#rel/}
    target_section=${target_section%.*}
    if [ "$target_section" == "master" ] ; then
        # handle master branch specially, all contents is copied, not just docs
        target_section=""
        # number of path segments to throw away by tar: content/en => 2
        strip_count=2
        src_section=""
    else
        # number of path segments to throw away by tar: content/en/x.y => 3
        strip_count=3
        if git ls-tree -d "$branch" -- "content/en/docs" | grep -q "content/en/docs"; then
          src_section=docs
        else
          src_section=latest
        fi
    fi
    if [ "$target_section" == "$current_section" ] ; then
        # copy the current docs to proper section
        echo "Getting data from workdir for $branch"
        cp -r "content/en/$src_dir" "$content_dir/$current_section"
    else
        echo "Getting data from remote $branch branch"
        # TODO: Update path and components when we move hugo to repo root
        mkdir -p "$content_dir/$target_section"
        git archive "$branch" "content/en/$src_section" | tar xf - -C "$content_dir/$target_section" \
            --strip-components=$strip_count "content/en/$src_section"
    fi
    GRIFFE_GEN_FILE="$branch:scripts/docs/griffe_builder.py"
    LEGACY_GEN_FILE="$branch:scripts/docs/json_builder.py"
    if git cat-file -e "$GRIFFE_GEN_FILE" 2>/dev/null || git cat-file -e "$LEGACY_GEN_FILE" 2>/dev/null; then
        echo "Generating API ref..."
        if [ "$target_section" == "" ] ; then
            echo "Skipping master api ref"
        else
            if git ls-tree --name-only "$branch" | grep -q "^api_spec.toml$"; then
                git checkout "$branch" -- api_spec.toml
            else
              echo "removing the API_spec"
              rm -rf api_spec.toml
            fi
            # Always use griffe (static analysis, no imports needed).
            # Works on any branch's source code via --search-path.
            python3 ../scripts/docs/griffe_builder.py \
                --search-path ../packages/gooddata-sdk/src \
                --search-path ../packages/gooddata-pandas/src \
                --output data.json \
                gooddata_sdk gooddata_pandas
            python3 ../scripts/docs/python_ref_builder.py api_spec.toml data.json "$target_section" versioned_docs \
                --export-links links.json
            # Pre-render method pages with api_ref directives.
            # Always use the current branch's renderer — old branches have Hugo shortcodes
            # (parameters-block, parameter) whose templates were removed.
            python3 ../scripts/docs/method_page_renderer.py \
                data.json "versioned_docs/$target_section" \
                --links-json links.json
            rm -f data.json links.json
        fi
    fi
done

# Master has to be erased first, as it is in '/latest' and we want to move the latest version there.
echo "master docs will not be published, removing"
rm -rf "${content_dir}/latest"

## Moving the highest version to latest
highest_version=$(ls -v1 ./versioned_docs/ | grep -E '^[0-9]+.[0-9]+$' | sort -V | tail -n 1)
echo "Moving ${highest_version} to /latest"
mv -f ./versioned_docs/$highest_version ./versioned_docs/latest

popd