fix(release): make publish protected-branch safe #235
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| #!/usr/bin/env node | ||
|
|
||
| import { pathToFileURL } from 'node:url' | ||
|
|
||
| function parseBoolean(value, name) { | ||
| if (value === 'true') return true | ||
| if (value === 'false') return false | ||
| throw new Error(`${name} must be true or false`) | ||
| } | ||
|
|
||
| export function planReleaseState({ | ||
| published, | ||
| tagTarget, | ||
| head, | ||
| tagPayloadMatches, | ||
| registryPayloadMatches, | ||
| }) { | ||
| if (!head) throw new Error('head is required') | ||
|
|
||
| if (published && !registryPayloadMatches) { | ||
| throw new Error('published package payload or provenance does not match this checkout') | ||
| } | ||
|
|
||
| if (!tagTarget) { | ||
| return { | ||
| state: published ? 'recover-missing-tag' : 'new-release', | ||
| createTag: true, | ||
| publish: !published, | ||
| } | ||
| } | ||
|
|
||
| if (tagTarget === head) { | ||
| return { | ||
| state: published ? 'complete' : 'resume-after-tag', | ||
| createTag: false, | ||
| publish: !published, | ||
| } | ||
| } | ||
|
|
||
| if (published && tagPayloadMatches) { | ||
| return { | ||
| state: 'complete-equivalent-legacy-tag', | ||
| createTag: false, | ||
| publish: false, | ||
| } | ||
| } | ||
|
|
||
| throw new Error(`release tag points to ${tagTarget}, not ${head}`) | ||
| } | ||
|
|
||
| function readArgs(argv) { | ||
| const values = new Map() | ||
| for (let index = 0; index < argv.length; index += 2) { | ||
| const key = argv[index] | ||
| const value = argv[index + 1] | ||
| if (!key?.startsWith('--') || value === undefined) { | ||
| throw new Error(`invalid argument near ${key ?? '<end>'}`) | ||
| } | ||
| values.set(key.slice(2), value) | ||
| } | ||
| return { | ||
| published: parseBoolean(values.get('published'), 'published'), | ||
| tagTarget: values.get('tag-target') ?? '', | ||
| head: values.get('head') ?? '', | ||
| tagPayloadMatches: parseBoolean(values.get('tag-payload-matches'), 'tag-payload-matches'), | ||
| registryPayloadMatches: parseBoolean( | ||
| values.get('registry-payload-matches'), | ||
| 'registry-payload-matches', | ||
| ), | ||
| } | ||
| } | ||
|
|
||
| if (process.argv[1] && import.meta.url === pathToFileURL(process.argv[1]).href) { | ||
| try { | ||
| console.log(JSON.stringify(planReleaseState(readArgs(process.argv.slice(2))))) | ||
| } catch (error) { | ||
| console.error(error instanceof Error ? error.message : String(error)) | ||
| process.exitCode = 1 | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| #!/usr/bin/env bash | ||
| set -euo pipefail | ||
|
|
||
| VERSION=${1:?usage: verify-release-payload.sh VERSION [LOCAL_PACKAGE_DIR]} | ||
| LOCAL_PACKAGE_DIR=${2:-$PWD} | ||
| PACKAGE_NAME=@agent-relay/factory | ||
| TMP_DIR=$(mktemp -d) | ||
| trap 'rm -rf "$TMP_DIR"' EXIT | ||
|
|
||
| mkdir "$TMP_DIR/local" "$TMP_DIR/registry" "$TMP_DIR/local-x" "$TMP_DIR/registry-x" | ||
| (cd "$LOCAL_PACKAGE_DIR" && npm pack --pack-destination "$TMP_DIR/local" --silent >/dev/null) | ||
| npm pack "$PACKAGE_NAME@$VERSION" --pack-destination "$TMP_DIR/registry" --silent >/dev/null | ||
| tar -xzf "$TMP_DIR/local"/*.tgz -C "$TMP_DIR/local-x" | ||
| tar -xzf "$TMP_DIR/registry"/*.tgz -C "$TMP_DIR/registry-x" | ||
| diff -qr "$TMP_DIR/local-x/package" "$TMP_DIR/registry-x/package" | ||
|
There was a problem hiding this comment. P2: Release recovery can accept an npm payload whose executable bits differ from this checkout because Prompt for AI agents |
||
|
|
||
| PROVENANCE=$(npm view "$PACKAGE_NAME@$VERSION" \ | ||
| dist.attestations.provenance.predicateType 2>/dev/null || true) | ||
| if [ "$PROVENANCE" != "https://slsa.dev/provenance/v1" ]; then | ||
| echo "Expected SLSA provenance for $PACKAGE_NAME@$VERSION, got: ${PROVENANCE:-<missing>}" >&2 | ||
| exit 1 | ||
| fi | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P1: A merge to main during the workflow can make this check stale, while the later tag and npm publish still use
$GITHUB_SHA; the job can therefore release a commit that is no longer currentorigin/main. Revalidation immediately before both side effects, together with serialization or an atomic head check, would preserve the canonical-main guarantee.Prompt for AI agents