Skip to content

Buildkite: post docs-build-pr GitHub status from a follow-up step #3359

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
reakaleek wants to merge 1 commit into
base: master
Choose a base branch
from
+17 −3
Draft

Buildkite: post docs-build-pr GitHub status from a follow-up step #3359

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions .buildkite/hooks/pre-exit
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,23 @@

set -euo pipefail

if [[ "$BUILDKITE_PIPELINE_SLUG" == "docs-build-pr" ]] && [[ "$BUILDKITE_STEP_KEY" == "build-pr" ]]; then
# Do not call GitHub from this hook. build-pr can run longer than the
# ephemeral VAULT_GITHUB_TOKEN TTL. Upload a short follow-up step instead
# so the environment hook mints a fresh token for the status POST.
if [[ "${BUILDKITE_PIPELINE_SLUG:-}" == "docs-build-pr" ]] && [[ "${BUILDKITE_STEP_KEY:-}" == "build-pr" ]]; then
status_state=failure
if [[ "${BUILDKITE_COMMAND_EXIT_STATUS:-1}" -eq 0 ]]; then
status_state=success
fi
"${BUILDKITE_BUILD_CHECKOUT_PATH}/.buildkite/scripts/build_pr_commit_status.sh" "$status_state" || true

echo "Uploading GitHub status step (${status_state})"

# Checkout is required so build_pr_commit_status.sh is on disk. The job
# is short; the environment hook mints a fresh VAULT_GITHUB_TOKEN.
cat <<YAML | buildkite-agent pipeline upload
steps:
- key: "github-status-${BUILDKITE_JOB_ID}"
label: "GitHub status"
command: ".buildkite/scripts/build_pr_commit_status.sh ${status_state}"
YAML
fi
3 changes: 2 additions & 1 deletion .buildkite/scripts/build_pr_commit_status.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,11 @@ githubPublishStatus="https://api.github.com/repos/${GITHUB_PR_BASE_OWNER}/${GITH
data='{"state":"'$status_state'","target_url":"'$BUILDKITE_BUILD_URL'","description":"'$description'","context":"buildkite/'$BUILDKITE_PIPELINE_SLUG'"}'

echo "Setting commit status: buildkite/${BUILDKITE_PIPELINE_SLUG} - ${status_state}"
curl -s -L \
curl --fail -sS -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer ${VAULT_GITHUB_TOKEN}" \
-H "X-GitHub-Api-Version: 2022-11-28" \
"${githubPublishStatus}" \
-d "${data}"
echo
Loading