|
| 1 | +# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json |
| 2 | + |
| 3 | +# This reusable workflow updates the Cargo.lock files in guest crates when |
| 4 | +# Dependabot updates dependencies. Without this, Dependabot PRs only update the |
| 5 | +# root Cargo.lock, leaving the guest crate Cargo.lock files stale. |
| 6 | +# |
| 7 | +# See: https://docs.github.com/en/code-security/tutorials/secure-your-dependencies/automating-dependabot-with-github-actions |
| 8 | + |
| 9 | +name: Update Guest Cargo.lock for Dependabot PRs |
| 10 | + |
| 11 | +on: |
| 12 | + workflow_call: |
| 13 | + |
| 14 | +env: |
| 15 | + CARGO_TERM_COLOR: always |
| 16 | + |
| 17 | +permissions: |
| 18 | + contents: read |
| 19 | + pull-requests: read |
| 20 | + |
| 21 | +defaults: |
| 22 | + run: |
| 23 | + shell: bash |
| 24 | + |
| 25 | +jobs: |
| 26 | + update-guest-locks: |
| 27 | + runs-on: [self-hosted, Linux, X64, "1ES.Pool=hld-kvm-amd"] |
| 28 | + timeout-minutes: 15 |
| 29 | + steps: |
| 30 | + # Fetch metadata about the Dependabot PR |
| 31 | + - name: Dependabot metadata |
| 32 | + id: metadata |
| 33 | + uses: dependabot/fetch-metadata@v2 |
| 34 | + with: |
| 35 | + github-token: "${{ secrets.GITHUB_TOKEN }}" |
| 36 | + |
| 37 | + # Only proceed for cargo ecosystem updates |
| 38 | + - name: Check if cargo update |
| 39 | + id: check-ecosystem |
| 40 | + run: | |
| 41 | + if [ "${{ steps.metadata.outputs.package-ecosystem }}" = "cargo" ]; then |
| 42 | + echo "is_cargo=true" >> "$GITHUB_OUTPUT" |
| 43 | + else |
| 44 | + echo "is_cargo=false" >> "$GITHUB_OUTPUT" |
| 45 | + echo "Skipping non-cargo dependency update" |
| 46 | + fi |
| 47 | +
|
| 48 | + # Get GitHub App token for pushing commits back to the PR |
| 49 | + # Uses the same app as auto-merge-dependabot.yml |
| 50 | + - name: Get GitHub App token |
| 51 | + if: steps.check-ecosystem.outputs.is_cargo == 'true' |
| 52 | + uses: actions/create-github-app-token@v2 |
| 53 | + id: get-app-token |
| 54 | + with: |
| 55 | + app-id: ${{ secrets.DEPENDABOT_APP_ID }} |
| 56 | + private-key: ${{ secrets.DEPENDABOT_APP_KEY }} |
| 57 | + permission-contents: write |
| 58 | + |
| 59 | + - name: Checkout PR branch |
| 60 | + if: steps.check-ecosystem.outputs.is_cargo == 'true' |
| 61 | + uses: actions/checkout@v6 |
| 62 | + with: |
| 63 | + token: ${{ steps.get-app-token.outputs.token }} |
| 64 | + ref: ${{ github.head_ref }} |
| 65 | + fetch-depth: 0 |
| 66 | + persist-credentials: false |
| 67 | + |
| 68 | + - name: Setup Rust toolchain |
| 69 | + if: steps.check-ecosystem.outputs.is_cargo == 'true' |
| 70 | + uses: hyperlight-dev/ci-setup-workflow@v1.8.0 |
| 71 | + with: |
| 72 | + rust-toolchain: "1.89" |
| 73 | + env: |
| 74 | + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
| 75 | + |
| 76 | + - name: Fix cargo home permissions |
| 77 | + if: steps.check-ecosystem.outputs.is_cargo == 'true' |
| 78 | + run: | |
| 79 | + sudo chown -R $(id -u):$(id -g) /opt/cargo || true |
| 80 | +
|
| 81 | + - name: Update simpleguest Cargo.lock |
| 82 | + if: steps.check-ecosystem.outputs.is_cargo == 'true' |
| 83 | + working-directory: src/tests/rust_guests/simpleguest |
| 84 | + run: cargo fetch |
| 85 | + |
| 86 | + - name: Update dummyguest Cargo.lock |
| 87 | + if: steps.check-ecosystem.outputs.is_cargo == 'true' |
| 88 | + working-directory: src/tests/rust_guests/dummyguest |
| 89 | + run: cargo fetch |
| 90 | + |
| 91 | + - name: Update witguest Cargo.lock |
| 92 | + if: steps.check-ecosystem.outputs.is_cargo == 'true' |
| 93 | + working-directory: src/tests/rust_guests/witguest |
| 94 | + run: cargo fetch |
| 95 | + |
| 96 | + # Commits created via the Git Data API are automatically signed/verified |
| 97 | + # by GitHub when authenticated as a GitHub App and no custom author or |
| 98 | + # committer info is provided. |
| 99 | + # |
| 100 | + # References: |
| 101 | + # - Signature verification for bots: |
| 102 | + # https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification#signature-verification-for-bots |
| 103 | + # - How to Use Commit Signing with GitHub Apps: |
| 104 | + # https://github.com/orgs/community/discussions/50055 |
| 105 | + # - Git Data API (Create a commit): |
| 106 | + # https://docs.github.com/en/rest/git/commits#create-a-commit |
| 107 | + - name: Commit and push changes via API |
| 108 | + if: steps.check-ecosystem.outputs.is_cargo == 'true' |
| 109 | + env: |
| 110 | + GH_TOKEN: ${{ steps.get-app-token.outputs.token }} |
| 111 | + APP_SLUG: ${{ steps.get-app-token.outputs.app-slug }} |
| 112 | + DEPENDENCY_NAMES: ${{ steps.metadata.outputs.dependency-names }} |
| 113 | + BRANCH: ${{ github.head_ref }} |
| 114 | + REPO: ${{ github.repository }} |
| 115 | + run: | |
| 116 | + set -euo pipefail |
| 117 | +
|
| 118 | + # Check if there are any changes to the guest Cargo.lock files |
| 119 | + if git diff --quiet -- src/tests/rust_guests/*/Cargo.lock; then |
| 120 | + echo "No changes to guest Cargo.lock files" |
| 121 | + exit 0 |
| 122 | + fi |
| 123 | +
|
| 124 | + echo "Guest Cargo.lock files have changed, committing via API..." |
| 125 | +
|
| 126 | + # Get app identity for DCO sign-off trailer |
| 127 | + # Use the app-slug output from create-github-app-token (the /app API |
| 128 | + # endpoint requires JWT auth, not an installation token). |
| 129 | + app_slug="${APP_SLUG}" |
| 130 | + app_user_id=$(gh api "/users/${app_slug}[bot]" --jq .id) |
| 131 | +
|
| 132 | + # Get current branch HEAD and its tree |
| 133 | + HEAD_SHA=$(gh api "/repos/${REPO}/git/ref/heads/${BRANCH}" --jq .object.sha) |
| 134 | + BASE_TREE=$(gh api "/repos/${REPO}/git/commits/${HEAD_SHA}" --jq .tree.sha) |
| 135 | +
|
| 136 | + # Build tree entries with file content for each changed Cargo.lock. |
| 137 | + # The tree API accepts "content" directly and creates blobs for us, |
| 138 | + # avoiding the need for separate blob creation API calls. |
| 139 | + TREE_JSON="[]" |
| 140 | + for file in $(git diff --name-only -- src/tests/rust_guests/*/Cargo.lock); do |
| 141 | + TREE_JSON=$(jq \ |
| 142 | + --arg path "$file" \ |
| 143 | + --arg content "$(cat "$file")" \ |
| 144 | + '. + [{"path": $path, "mode": "100644", "type": "blob", "content": $content}]' \ |
| 145 | + <<< "$TREE_JSON") |
| 146 | + done |
| 147 | +
|
| 148 | + # Create a new tree with the updated files |
| 149 | + NEW_TREE=$(jq -n \ |
| 150 | + --arg base "$BASE_TREE" \ |
| 151 | + --argjson tree "$TREE_JSON" \ |
| 152 | + '{"base_tree": $base, "tree": $tree}' | \ |
| 153 | + gh api "/repos/${REPO}/git/trees" --input - --jq .sha) |
| 154 | +
|
| 155 | + # Build commit message with DCO sign-off |
| 156 | + SIGNOFF="${app_slug}[bot] <${app_user_id}+${app_slug}[bot]@users.noreply.github.com>" |
| 157 | + COMMIT_MSG=$(printf '%s\n\n%s\n%s\n\n%s' \ |
| 158 | + "chore: update guest Cargo.lock files" \ |
| 159 | + "Automatically updated by dependabot-update-guest-locks workflow." \ |
| 160 | + "Triggered by: ${DEPENDENCY_NAMES}" \ |
| 161 | + "Signed-off-by: ${SIGNOFF}") |
| 162 | +
|
| 163 | + # Create commit via API — GitHub signs it automatically since we |
| 164 | + # authenticate as the App and omit custom author/committer info. |
| 165 | + NEW_COMMIT=$(jq -n \ |
| 166 | + --arg msg "$COMMIT_MSG" \ |
| 167 | + --arg tree "$NEW_TREE" \ |
| 168 | + --arg parent "$HEAD_SHA" \ |
| 169 | + '{"message": $msg, "tree": $tree, "parents": [$parent]}' | \ |
| 170 | + gh api "/repos/${REPO}/git/commits" --input - --jq .sha) |
| 171 | +
|
| 172 | + # Update branch ref to point to the new commit |
| 173 | + gh api "/repos/${REPO}/git/refs/heads/${BRANCH}" \ |
| 174 | + -X PATCH \ |
| 175 | + -f sha="${NEW_COMMIT}" |
| 176 | +
|
| 177 | + echo "Successfully committed and pushed changes" |
0 commit comments