Skip to content

fix(release): make product promotion finalization resilient #196

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

Merged
pallyoung merged 1 commit into from
Aug 25, 2026
Merged

fix(release): make product promotion finalization resilient #196

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
33 changes: 22 additions & 11 deletions .github/workflows/product-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -848,24 +848,35 @@ jobs:
--latest=false
fi

- name: Verify promoted Product
run: |
selected_version=$(npm view "${PACKAGE_NAME}@${FINAL_DIST_TAG}" version --json | node -p "JSON.parse(require('fs').readFileSync(0, 'utf8'))")
if [[ "${selected_version}" != "${PRODUCT_VERSION}" ]]; then
echo "Final npm dist-tag does not resolve to the accepted Product" >&2
exit 1
fi
mkdir -p release/product-promotion/final
gh release download product-stable --pattern product-channel.json --dir release/product-promotion/final
- name: Verify promoted Product
run: |
selected_version=""
for attempt in 1 2 3 4 5 6; do
selected_version=$(npm view "${PACKAGE_NAME}@${FINAL_DIST_TAG}" version --json 2>/dev/null | node -p "JSON.parse(require('fs').readFileSync(0, 'utf8'))") || true
if [[ "${selected_version}" == "${PRODUCT_VERSION}" ]]; then
break
fi
if [[ "${attempt}" == "6" ]]; then
echo "Final npm dist-tag does not resolve to the accepted Product" >&2
exit 1
fi
echo "npm dist-tag has not propagated yet (attempt ${attempt}/6); retrying in 10 seconds"
sleep 10
done
mkdir -p release/product-promotion/final
gh release download product-stable --pattern product-channel.json --dir release/product-promotion/final
final_digest=$(sha256sum release/product-promotion/final/product-channel.json | cut -d ' ' -f 1)
final_version=$(node -p "require('./release/product-promotion/final/product-channel.json').version")
if [[ "${final_digest}" != "${PRODUCT_CHANNEL_SHA256}" || "${final_version}" != "${PRODUCT_VERSION}" ]]; then
echo "Promoted Product stable pointer verification failed" >&2
exit 1
fi

- name: Remove temporary npm dist-tag
run: npm dist-tag rm "${PACKAGE_NAME}" "${ACCEPTANCE_DIST_TAG}"
- name: Remove temporary npm dist-tag
run: |
if ! npm dist-tag rm "${PACKAGE_NAME}" "${ACCEPTANCE_DIST_TAG}"; then
echo "::warning::Unable to remove temporary npm dist-tag ${ACCEPTANCE_DIST_TAG}; promotion is already complete"
fi

- name: Record Product promotion
run: |
Expand Down
5 changes: 5 additions & 0 deletions scripts/github-workflows.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,12 @@ describe("Product publication workflow", () => {
expect(steps[releaseIndex]?.run).toContain("--prerelease=false --latest=false");
expect(steps[pointerIndex]?.run).toContain("product-stable");
expect(steps[pointerIndex]?.run).toContain("product-channel.json");
expect(steps[verifyIndex]?.run).toContain("for attempt in 1 2 3 4 5 6");
expect(steps[verifyIndex]?.run).toContain("sleep 10");
expect(steps[cleanupIndex]?.run).toContain("npm dist-tag rm");
expect(steps[cleanupIndex]?.run).toContain(
"::warning::Unable to remove temporary npm dist-tag"
);
expect(steps[recordIndex]?.run).toContain("promotion.json");
expect(steps[recordIndex]?.run).toContain(
"release-workflow-helpers.ts verify-existing-promotion-record"
Expand Down
Loading