Skip to content

Emit workflow pins as a downloadable patch artifact #127

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
jeffhandley merged 2 commits into from
Jun 13, 2026
+62 −24
Merged

Emit workflow pins as a downloadable patch artifact #127

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
12fdb22
Emit workflow pins as a downloadable patch artifact
jeffhandley Jun 13, 2026
4f5396d
Skip release commit when predict/action.yml is already pinned
jeffhandley Jun 13, 2026
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
86 changes: 62 additions & 24 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,12 +112,12 @@ jobs:
- publish-predictor
permissions:
contents: write
packages: read

steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

- name: "Update workflow pins and the `predict` action for the release"
- name: "Commit the `predict` image update and capture workflow pin patch"
id: release
env:
REF_NAME: ${{ github.ref_name }}
IMAGE_TAG: ${{ needs.compute-image-tag.outputs.image_tag }}
Expand All @@ -127,7 +127,6 @@ jobs:
REPO_BLOB_URL_BASE: ${{ format('{0}/{1}/blob', github.server_url, github.repository) }}
REPO_COMMIT_URL_BASE: ${{ format('{0}/{1}/commit', github.server_url, github.repository) }}
run: |
RELEASE_SHA="$(git rev-parse HEAD)"
WORKFLOW_FILES=(
".github/workflows/labeler-cache-retention.yml"
".github/workflows/labeler-predict-discussions.yml"
Expand All @@ -137,33 +136,72 @@ jobs:
".github/workflows/labeler-train.yml"
)

for workflow_file in "${WORKFLOW_FILES[@]}"; do
perl -0pi -e "s{^([[:space:]]*uses:[[:space:]]*dotnet/issue-labeler/(?:download|train|test|restore|promote|predict)@)[^[:space:]#]+(?:[[:space:]]*#.*)?\$}{\\1${RELEASE_SHA} # ${REF_NAME}}mg" "$workflow_file"
done

PREDICT_ACTION="predict/action.yml"
sed -i "s|^[[:space:]]*image:[[:space:]]*docker://ghcr\.io/.*\$| image: docker://${IMAGE_DIGEST} # ${IMAGE_TAG}|" "$PREDICT_ACTION"

git config user.name "GitHub Actions"
git config user.email "actions@github.com"
git add "${WORKFLOW_FILES[@]}" "$PREDICT_ACTION"
git commit -m "Release '${REF_NAME}' with predictor digest '${RELEASE_DIGEST}' and workflow pins"
RELEASE_COMMIT_SHA="$(git rev-parse HEAD)"
RELEASE_COMMIT_URL="${REPO_COMMIT_URL_BASE}/${RELEASE_COMMIT_SHA}"
git push origin "$REF_NAME"
git add "$PREDICT_ACTION"
if git diff --cached --quiet; then
echo "predict/action.yml already pinned to ${IMAGE_DIGEST}; skipping release commit."
else
git commit -m "Release '${REF_NAME}' with predictor digest '${RELEASE_DIGEST}'"
git push origin "$REF_NAME"
fi

RELEASE_SHA="$(git rev-parse HEAD)"
RELEASE_COMMIT_URL="${REPO_COMMIT_URL_BASE}/${RELEASE_SHA}"

Comment thread
jeffhandley marked this conversation as resolved.
echo "> [!NOTE]" >> "$GITHUB_STEP_SUMMARY"
echo "> Updated workflow pins on release branch [\`${REF_NAME}\`](${REPO_TREE_URL_BASE}/${REF_NAME}) to [\`${RELEASE_SHA}\`](${RELEASE_COMMIT_URL})." >> "$GITHUB_STEP_SUMMARY"
echo "" >> "$GITHUB_STEP_SUMMARY"
echo "> Workflow files:" >> "$GITHUB_STEP_SUMMARY"
for workflow_file in "${WORKFLOW_FILES[@]}"; do
echo "> - \`$workflow_file\`" >> "$GITHUB_STEP_SUMMARY"
perl -0pi -e "s{^([[:space:]]*(?:-[[:space:]]+)?uses:[[:space:]]+dotnet/issue-labeler/(?:download|train|test|restore|promote|predict)@)[^[:space:]#]+(?:[[:space:]]+#.*)?\$}{\${1}${RELEASE_SHA} # ${REF_NAME}}mg" "$workflow_file"
done
echo "" >> "$GITHUB_STEP_SUMMARY"
echo "> Updated [\`predict/action.yml\` (${REF_NAME})](${REPO_BLOB_URL_BASE}/${REF_NAME}/predict/action.yml) to:" >> "$GITHUB_STEP_SUMMARY"
echo "> \`${IMAGE_DIGEST}\`" >> "$GITHUB_STEP_SUMMARY"
echo "" >> "$GITHUB_STEP_SUMMARY"

echo "\`\`\`yml" >> "$GITHUB_STEP_SUMMARY"
grep -i -B1 -A10 '^\s*using:\s*docker' "$PREDICT_ACTION" >> "$GITHUB_STEP_SUMMARY"
echo "\`\`\`" >> "$GITHUB_STEP_SUMMARY"
PATCH_FILE="${RUNNER_TEMP}/workflow-pins.patch"
git diff -- "${WORKFLOW_FILES[@]}" > "$PATCH_FILE"
git checkout -- "${WORKFLOW_FILES[@]}"

if [[ -s "$PATCH_FILE" ]]; then
HAS_PATCH="true"
else
HAS_PATCH="false"
rm -f "$PATCH_FILE"
fi

echo "release_sha=$RELEASE_SHA" >> "$GITHUB_OUTPUT"
echo "release_commit_url=$RELEASE_COMMIT_URL" >> "$GITHUB_OUTPUT"
echo "patch_file=$PATCH_FILE" >> "$GITHUB_OUTPUT"
echo "has_patch=$HAS_PATCH" >> "$GITHUB_OUTPUT"

{
echo "> [!NOTE]"
echo "> Released [\`${REF_NAME}\`](${REPO_TREE_URL_BASE}/${REF_NAME}) as [\`${RELEASE_SHA}\`](${RELEASE_COMMIT_URL})."
echo ""
echo "> Updated [\`predict/action.yml\` (${REF_NAME})](${REPO_BLOB_URL_BASE}/${REF_NAME}/predict/action.yml) image to:"
echo "> \`${IMAGE_DIGEST}\`"
echo ""
echo "\`\`\`yml"
grep -i -B1 -A10 '^\s*using:\s*docker' "$PREDICT_ACTION"
echo "\`\`\`"
} >> "$GITHUB_STEP_SUMMARY"

if [[ "$HAS_PATCH" == "true" ]]; then
{
echo ""
echo "> [!IMPORTANT]"
echo "> The labeler workflow files reference \`dotnet/issue-labeler/*\` actions and need to be re-pinned to [\`${RELEASE_SHA}\`](${RELEASE_COMMIT_URL}) (\`${REF_NAME}\`)."
echo "> \`GITHUB_TOKEN\` cannot modify files under \`.github/workflows/\`, so the updates are emitted as a patch."
echo "> Download the \`workflow-pins.patch\` artifact from this run, apply it with \`git apply\`, and open a follow-up pull request."
echo ""
echo "\`\`\`diff"
cat "$PATCH_FILE"
echo "\`\`\`"
} >> "$GITHUB_STEP_SUMMARY"
fi

- name: "Upload workflow-pins.patch artifact"
if: ${{ steps.release.outputs.has_patch == 'true' }}
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
with:
name: workflow-pins.patch
path: ${{ steps.release.outputs.patch_file }}
if-no-files-found: error
Loading