buddy.inc.sh

#!/usr/bin/env bash
# shellcheck disable=SC2034
set -euo pipefail

function yp_ci_env_buddy() {
    [[ "${BUDDY:-}" = "true" ]] || return 0

    export CI=true
    YP_CI_NAME=Buddy
    YP_CI_PLATFORM=buddy
    YP_CI_SERVER_HOST=buddy.works
    YP_CI_REPO_SLUG=${BUDDY_REPO_SLUG:-}
    YP_CI_ROOT=${WORKING_DIR:-}

    YP_CI_IS_CRON=
    [[ "${BUDDY_PIPELINE_TRIGGER_MODE:-}" != "SCHEDULE" ]] || YP_CI_IS_CRON=true
    YP_CI_IS_PR=
    [[ -z "${BUDDY_EXECUTION_PULL_REQUEST_ID:-}" ]] || YP_CI_IS_PR=true

    # 1 pipeline -> n jobs
    YP_CI_JOB_ID=${BUDDY_EXECUTION_ID:-}
    YP_CI_PIPELINE_ID=${BUDDY_PIPELINE_ID:-}
    YP_CI_JOB_URL=${BUDDY_EXECUTION_URL:-}
    YP_CI_PIPELINE_URL=${BUDDY_PIPELINE_URL:-}

    YP_CI_PR_NUMBER=
    YP_CI_PR_URL=
    YP_CI_PR_REPO_SLUG=
    YP_CI_PR_GIT_HASH=
    YP_CI_PR_GIT_BRANCH=
    [[ "${YP_CI_IS_PR}" != "true" ]] || {
        YP_CI_PR_NUMBER=${BUDDY_EXECUTION_PULL_REQUEST_NO:-}
        YP_CI_PR_URL=https://github.com/${YP_CI_REPO_SLUG}/pull/${YP_CI_PR_NUMBER}
        YP_CI_PR_REPO_SLUG= # TODO
        YP_CI_PR_GIT_HASH= # TODO
        YP_CI_PR_GIT_BRANCH=${BUDDY_EXECUTION_PULL_REQUEST_HEAD_BRANCH:-}
    }

    YP_CI_GIT_HASH=${BUDDY_EXECUTION_REVISION:-}
    YP_CI_GIT_BRANCH=${BUDDY_EXECUTION_BRANCH:-}
    [[ "${YP_CI_IS_PR}" != "true" ]] || YP_CI_GIT_BRANCH=${BUDDY_EXECUTION_PULL_REQUEST_BASE_BRANCH:-}
    YP_CI_GIT_TAG=${BUDDY_EXECUTION_TAG:-}

    YP_CI_DEBUG_MODE=${YP_CI_DEBUG_MODE:-}
}

function yp_ci_printvars_buddy() {
    printenv_all | sort -u | grep \
        -e "^CI=" \
        -e "^BUDDY[=_]" \
        -e "^WORKING_DIR="
}

function yp_ci_known_env_buddy() {
    # see https://buddy.works/docs/pipelines/environment-variables#default-environment-variables
    cat <<EOF
CI
BUDDY
BUDDY_EXECUTION_BRANCH
BUDDY_EXECUTION_CHANGELOG
BUDDY_EXECUTION_CHANGELOG_ADDED
BUDDY_EXECUTION_CHANGELOG_CHANGED
BUDDY_EXECUTION_CHANGELOG_DELETED
BUDDY_EXECUTION_CLEAR_CACHE
BUDDY_EXECUTION_COMMENT
BUDDY_EXECUTION_ID
BUDDY_EXECUTION_MODE
BUDDY_EXECUTION_PREVIOUS_REVISION
BUDDY_EXECUTION_PREVIOUS_REVISION_MESSAGE
BUDDY_EXECUTION_PREVIOUS_REVISION_SUBJECT
BUDDY_EXECUTION_PULL_REQUEST_BASE_BRANCH
BUDDY_EXECUTION_PULL_REQUEST_HEAD_BRANCH
BUDDY_EXECUTION_PULL_REQUEST_ID
BUDDY_EXECUTION_PULL_REQUEST_NO
BUDDY_EXECUTION_REFRESH
BUDDY_EXECUTION_REVISION
BUDDY_EXECUTION_REVISION_COMMITTER_EMAIL
BUDDY_EXECUTION_REVISION_COMMITTER_NAME
BUDDY_EXECUTION_REVISION_MESSAGE
BUDDY_EXECUTION_REVISION_SHORT
BUDDY_EXECUTION_REVISION_SUBJECT
BUDDY_EXECUTION_REVISION_URL
BUDDY_EXECUTION_START_DATE
BUDDY_EXECUTION_TAG
BUDDY_EXECUTION_TIME
BUDDY_EXECUTION_URL
BUDDY_EXECUTION_WARNINGS_COUNT
BUDDY_FAILED_ACTION_LOGS
BUDDY_FAILED_ACTION_NAME
BUDDY_INVOKER_AVATAR_URL
BUDDY_INVOKER_EMAIL
BUDDY_INVOKER_ID
BUDDY_INVOKER_NAME
BUDDY_INVOKER_URL
BUDDY_PIPELINE_ID
BUDDY_PIPELINE_NAME
BUDDY_PIPELINE_REF_NAME
BUDDY_PIPELINE_TARGET_SITE_URL
BUDDY_PIPELINE_TRIGGER_MODE
BUDDY_PIPELINE_URL
BUDDY_PROJECT_NAME
BUDDY_PROJECT_NAME_ID
BUDDY_PROJECT_URL
BUDDY_REPO_SLUG
BUDDY_REPO_SSH_URL
BUDDY_SCM_PROVIDER
BUDDY_SCM_URL
BUDDY_WORKSPACE_DOMAIN
BUDDY_WORKSPACE_ID
BUDDY_WORKSPACE_NAME
BUDDY_WORKSPACE_URL
EOF
    # undocumented but observed
    cat <<EOF
BUDDY_EXECUTION_EVENT_TYPE
BUDDY_EXECUTION_HASH
BUDDY_EXECUTION_PARALLEL_SLOT_NO
BUDDY_EXECUTION_REF
BUDDY_EXECUTION_REFS
BUDDY_EXECUTION_WEBHOOK_PAYLOAD
BUDDY_PIPELINE_REFS
BUDDY_SLOT_NO
WORKING_DIR
EOF
}