Files
codex-security/.github/workflows/node-github-release.yml
T
mldangelo-oaiandmldangelo-oai 32ceaff7db refactor(release): consolidate GitHub release publication (#1474)
* test(release): share release label and tag fixtures

* refactor(release): consolidate GitHub release publication

* fix(release): include publication helper in container builds

---------

Co-authored-by: mldangelo-oai <269034524+mldangelo-oai@users.noreply.github.com>
2026-10-09 01:34:47 -04:00

446 lines
16 KiB
YAML

name: node-github-release
on:
workflow_dispatch:
inputs:
tag:
description: Existing stable npm release tag
required: true
type: string
run_id:
description: Successful node-release run to use for backfill
required: false
type: string
permissions:
contents: read
concurrency:
group: node-github-release
queue: max
jobs:
release:
if: >-
github.repository == 'openai/codex-security' &&
github.ref == 'refs/heads/main'
name: publish verified GitHub release
runs-on: ubuntu-latest
permissions:
actions: read
contents: write
steps:
- name: Checkout release automation
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
fetch-depth: 0
persist-credentials: false
ref: refs/heads/main
- name: Set up Node.js
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
with:
node-version: "24.15.0"
registry-url: "https://registry.npmjs.org"
package-manager-cache: false
- name: Install provenance-capable npm
shell: bash
run: |
set -euo pipefail
npm_tools="$RUNNER_TEMP/codex-security-provenance-npm"
npm install \
--prefix "$npm_tools" \
--ignore-scripts \
--no-audit \
--no-fund \
--registry=https://openai.firewall.socket.dev/npm/ \
npm@11.12.1
if [[ "$("$npm_tools/node_modules/.bin/npm" --version)" != "11.12.1" ]]; then
echo "npm 11.12.1 is required to verify Sigstore attestations." >&2
exit 1
fi
printf '%s\n' "$npm_tools/node_modules/.bin" >> "$GITHUB_PATH"
- name: Verify bundled provenance-capable npm
shell: bash
run: |
set -euo pipefail
if [[ "$(npm --version)" != "11.12.1" ]]; then
echo "npm 11.12.1 is required to verify Sigstore attestations." >&2
exit 1
fi
- name: Resolve the successful protected release
id: release
shell: bash
env:
GH_TOKEN: ${{ github.token }}
INPUT_TAG: ${{ inputs.tag }}
INPUT_RUN_ID: ${{ inputs.run_id }}
run: |
set -euo pipefail
release_tag="${INPUT_TAG:-}"
release_run="${INPUT_RUN_ID:-}"
if [[ ! "$release_tag" =~ ^npm-v(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)$ ]]; then
echo "GitHub releases require an existing stable npm-vX.Y.Z tag." >&2
exit 1
fi
if ! tag_ref="$(
gh api \
"repos/$GITHUB_REPOSITORY/git/ref/tags/$release_tag" \
--jq '[.object.type, .object.sha] | @tsv'
)"; then
echo "GitHub releases require an existing stable npm-vX.Y.Z tag." >&2
exit 1
fi
IFS=$'\t' read -r tag_type tag_object <<< "$tag_ref"
if [[ ! "$tag_object" =~ ^[0-9a-fA-F]{40}$ ]]; then
echo "GitHub releases require a valid Git tag object." >&2
exit 1
fi
case "$tag_type" in
commit)
release_sha="$tag_object"
;;
tag)
if ! release_sha="$(
gh api \
"repos/$GITHUB_REPOSITORY/git/tags/$tag_object" \
--jq 'if .object.type == "commit" then .object.sha else empty end'
)"; then
echo "GitHub releases require a tag pointing to a commit." >&2
exit 1
fi
;;
*)
echo "GitHub releases require a tag pointing to a commit." >&2
exit 1
;;
esac
if [[ ! "$release_sha" =~ ^[0-9a-fA-F]{40}$ ]]; then
echo "GitHub releases require a tag pointing to a commit." >&2
exit 1
fi
if [[ -z "$release_run" ]]; then
release_run="$(
gh run list \
--repo "$GITHUB_REPOSITORY" \
--workflow node-release.yml \
--commit "$release_sha" \
--limit 20 \
--json databaseId,status,conclusion \
--jq '[.[] | select(.status == "completed" and .conclusion == "success")] | first | .databaseId // empty'
)"
fi
if [[ ! "$release_run" =~ ^[1-9][0-9]*$ ]]; then
echo "No successful protected npm release exists for $release_tag." >&2
exit 1
fi
for ((attempt = 1; attempt <= 30; attempt++)); do
run_fields="$(
gh api "repos/$GITHUB_REPOSITORY/actions/runs/$release_run" \
--jq '[.name, .status, (.conclusion // "pending"), .head_sha, .head_branch] | @tsv'
)"
IFS=$'\t' read -r run_name run_status run_conclusion run_sha run_tag <<< "$run_fields"
if [[ "$run_name" != "node-release" ||
"$run_sha" != "$release_sha" ||
"$run_tag" != "$release_tag" ]]; then
echo "The release run must successfully publish the exact tagged commit." >&2
exit 1
fi
if [[ "$run_status" == "completed" ]]; then
break
fi
if (( attempt == 30 )); then
echo "Timed out waiting for protected npm release $release_run to complete." >&2
exit 1
fi
sleep 2
done
if [[ "$run_conclusion" != "success" ]]; then
echo "The release run must successfully publish the exact tagged commit." >&2
exit 1
fi
{
printf 'tag=%s\n' "$release_tag"
printf 'version=%s\n' "${release_tag#npm-v}"
printf 'sha=%s\n' "$release_sha"
printf 'run-id=%s\n' "$release_run"
} >> "$GITHUB_OUTPUT"
- name: Wait for the published npm package
shell: bash
env:
RELEASE_VERSION: ${{ steps.release.outputs.version }}
run: |
set -euo pipefail
# npm can finish publishing before its registry makes the version available.
for attempt in {1..21}; do
if metadata="$(
npm view "@openai/codex-security@$RELEASE_VERSION" version \
--json --prefer-online --registry=https://registry.npmjs.org/
)"; then
exit 0
fi
printf '%s\n' "$metadata" >&2
if ! printf '%s\n' "$metadata" | node --input-type=module --eval '
import { readFileSync } from "node:fs";
const result = JSON.parse(readFileSync(0, "utf8"));
process.exit(result?.error?.code === "E404" ? 0 : 1);
'; then
exit 1
fi
if (( attempt == 21 )); then
echo "The published npm version did not become available within ten minutes." >&2
exit 1
fi
echo "Waiting for npm publication to become available." >&2
sleep 30
done
- name: Download the verified or durable npm release artifact
shell: bash
env:
GH_TOKEN: ${{ github.token }}
RELEASE_RUN_ID: ${{ steps.release.outputs.run-id }}
RELEASE_VERSION: ${{ steps.release.outputs.version }}
run: |
set -euo pipefail
mkdir -p dist
if ! gh run download "$RELEASE_RUN_ID" \
--repo "$GITHUB_REPOSITORY" \
--name npm-release-tarball \
--dir dist; then
echo "Release artifact expired; retrieving the public npm tarball."
npm pack "@openai/codex-security@$RELEASE_VERSION" \
--ignore-scripts \
--pack-destination dist \
--registry=https://registry.npmjs.org/
fi
- name: Verify the public npm package and signed provenance
id: artifact
shell: bash
env:
GH_TOKEN: ${{ github.token }}
RELEASE_RUN_ID: ${{ steps.release.outputs.run-id }}
RELEASE_VERSION: ${{ steps.release.outputs.version }}
RELEASE_SHA: ${{ steps.release.outputs.sha }}
RELEASE_TAG: ${{ steps.release.outputs.tag }}
run: |
set -euo pipefail
shopt -s nullglob
archives=(dist/*.tgz)
if (( ${#archives[@]} != 1 )); then
echo "Expected exactly one verified npm release tarball." >&2
exit 1
fi
archive="${archives[0]}"
metadata="$(
npm view "@openai/codex-security@$RELEASE_VERSION" \
name version gitHead dist.integrity dist.attestations \
--json \
--registry=https://registry.npmjs.org/
)"
consumer="$(mktemp -d)"
trap 'rm -rf "$consumer"' EXIT
npm install \
--prefix "$consumer" \
--ignore-scripts \
--omit=optional \
--no-audit \
--no-fund \
--registry=https://registry.npmjs.org/ \
"@openai/codex-security@$RELEASE_VERSION"
signature_report="$(
npm audit signatures \
--prefix "$consumer" \
--registry=https://registry.npmjs.org/ \
--json \
--include-attestations
)"
if verified_provenance="$(
printf '%s\n' "$signature_report" |
node sdk/typescript/scripts/release-automation.mjs \
verify-provenance \
"$archive" \
"$RELEASE_VERSION" \
"$RELEASE_SHA" \
"$GITHUB_REPOSITORY" \
"$RELEASE_RUN_ID"
)"; then
verified_run_id="$RELEASE_RUN_ID"
printf '%s\n' "$verified_provenance"
echo "Verified npm provenance for the resolved release run."
else
recovery_conclusion="$(
gh api \
"repos/$GITHUB_REPOSITORY/actions/runs/$RELEASE_RUN_ID/jobs?per_page=100" \
--paginate \
--jq '.jobs[] | select(.name == "publish") | .steps[] | select(.name == "Verify recovered npm release provenance") | .conclusion'
)"
if [[ "$recovery_conclusion" != "success" ]]; then
echo "Signed npm provenance must identify the resolved successful release run." >&2
exit 1
fi
verified_provenance="$(
printf '%s\n' "$signature_report" |
node sdk/typescript/scripts/release-automation.mjs \
verify-recovered-provenance \
"$archive" \
"$RELEASE_VERSION" \
"$RELEASE_SHA" \
"$GITHUB_REPOSITORY"
)"
original_run_id="$(
printf '%s\n' "$verified_provenance" |
node --input-type=module --eval '
import { readFileSync } from "node:fs";
const provenance = JSON.parse(readFileSync(0, "utf8"));
if (!/^[1-9][0-9]*$/.test(provenance.runId)) {
throw new Error("The signing run must be a valid workflow run.");
}
process.stdout.write(provenance.runId);
'
)"
original_run_fields="$(
gh api \
"repos/$GITHUB_REPOSITORY/actions/runs/$original_run_id" \
--jq '[.name, .status, .head_sha, .head_branch] | @tsv'
)"
IFS=$'\t' read -r original_name original_status original_sha original_tag <<< "$original_run_fields"
if [[ "$original_name" != "node-release" ||
"$original_status" != "completed" ||
"$original_sha" != "$RELEASE_SHA" ||
"$original_tag" != "$RELEASE_TAG" ]]; then
echo "Recovered npm provenance must identify the exact protected release." >&2
exit 1
fi
verified_run_id="$original_run_id"
printf '%s\n' "$verified_provenance"
echo "Verified protected recovery provenance from its original signing run."
fi
printf '%s\n' "$metadata" |
CODEX_SECURITY_VERIFIED_PROVENANCE="$verified_provenance" \
node sdk/typescript/scripts/release-automation.mjs \
verify-github-publication \
"$archive" \
"$RELEASE_VERSION" \
"$RELEASE_SHA" \
"$GITHUB_REPOSITORY" \
"$verified_run_id"
printf 'archive=%s\n' "$archive" >> "$GITHUB_OUTPUT"
- name: Resolve published release history
id: history
shell: bash
env:
GH_TOKEN: ${{ github.token }}
RELEASE_TAG: ${{ steps.release.outputs.tag }}
RELEASE_SHA: ${{ steps.release.outputs.sha }}
run: |
set -euo pipefail
published_versions="$(
npm view @openai/codex-security versions \
--json \
--registry=https://registry.npmjs.org/
)"
published_github_tags="$(
gh api --paginate \
"repos/$GITHUB_REPOSITORY/releases?per_page=100" \
--jq '.[] | select(.draft == false and .prerelease == false) | .tag_name'
)"
reachable_tags=""
if git rev-parse "$RELEASE_SHA^" >/dev/null 2>&1; then
reachable_tags="$(
git tag --merged "$RELEASE_SHA^" \
--list 'npm-v*' \
--sort=-version:refname
)"
fi
history="$(
CODEX_SECURITY_PUBLISHED_NPM_VERSIONS="$published_versions" \
CODEX_SECURITY_PUBLISHED_GITHUB_TAGS="$published_github_tags" \
CODEX_SECURITY_REACHABLE_RELEASE_TAGS="$reachable_tags" \
node sdk/typescript/scripts/release-automation.mjs \
release-history "$RELEASE_TAG"
)"
previous_tag="$(
printf '%s\n' "$history" |
node --input-type=module --eval '
import { readFileSync } from "node:fs";
const history = JSON.parse(readFileSync(0, "utf8"));
process.stdout.write(history.previousTag ?? "");
'
)"
make_latest="$(
printf '%s\n' "$history" |
node --input-type=module --eval '
import { readFileSync } from "node:fs";
const history = JSON.parse(readFileSync(0, "utf8"));
if (typeof history.makeLatest !== "boolean") {
throw new Error("Release latest status must be explicit.");
}
process.stdout.write(String(history.makeLatest));
'
)"
{
printf 'previous-tag=%s\n' "$previous_tag"
printf 'make-latest=%s\n' "$make_latest"
} >> "$GITHUB_OUTPUT"
- name: Publish GitHub Release and generated notes
shell: bash
env:
GH_TOKEN: ${{ github.token }}
RELEASE_TAG: ${{ steps.release.outputs.tag }}
RELEASE_VERSION: ${{ steps.release.outputs.version }}
RELEASE_SHA: ${{ steps.release.outputs.sha }}
RELEASE_ARCHIVE: ${{ steps.artifact.outputs.archive }}
PREVIOUS_TAG: ${{ steps.history.outputs.previous-tag }}
MAKE_LATEST: ${{ steps.history.outputs.make-latest }}
run: |
set -euo pipefail
release_workspace="$(mktemp -d)"
trap 'rm -rf "$release_workspace"' EXIT
node --input-type=module --eval '
import { publishGitHubRelease } from "./sdk/typescript/scripts/publish-github-release.mjs";
try {
publishGitHubRelease(process.env, process.argv[1]);
} catch (error) {
if (error.status === undefined) throw error;
process.exit(error.status);
}
' "$release_workspace"