|
| 1 | +# Automatic black formatting migration for Dependabot PRs |
| 2 | +# |
| 3 | +# When Dependabot upgrades black, this workflow installs the new version |
| 4 | +# and runs `black .` so the PR already contains any formatting changes |
| 5 | +# introduced by the upgrade, while leaving the PR open for review. |
| 6 | +# |
| 7 | +# Black uses calendar versioning. Only the first release of a new calendar |
| 8 | +# year may introduce formatting changes (major bump in Dependabot's terms). |
| 9 | +# Minor and patch updates within a year keep formatting stable, so they stay |
| 10 | +# in the regular Dependabot groups and are auto-merged normally. |
| 11 | +# |
| 12 | +# The companion auto-dependabot workflow skips major black PRs so they're |
| 13 | +# handled exclusively by this migration workflow. |
| 14 | +# |
| 15 | +# XXX: !!! SECURITY WARNING !!! |
| 16 | +# pull_request_target has write access to the repo, and can read secrets. |
| 17 | +# This is required because Dependabot PRs are treated as fork PRs: the |
| 18 | +# GITHUB_TOKEN is read-only and secrets are unavailable with a plain |
| 19 | +# pull_request trigger. The action mitigates the risk by: |
| 20 | +# - Never executing code from the PR (the migration script is embedded |
| 21 | +# in this workflow file on the base branch, not taken from the PR). |
| 22 | +# - Gating migration steps on github.actor == 'dependabot[bot]'. |
| 23 | +# - Running checkout with persist-credentials: false and isolating |
| 24 | +# push credentials from the migration script environment. |
| 25 | +# For more details read: |
| 26 | +# https://securitylab.github.com/research/github-actions-preventing-pwn-requests/ |
| 27 | + |
| 28 | +name: Black Migration |
| 29 | + |
| 30 | +on: |
| 31 | + merge_group: # To allow using this as a required check for merging |
| 32 | + pull_request_target: |
| 33 | + types: [opened, synchronize, reopened, labeled, unlabeled] |
| 34 | + |
| 35 | +permissions: |
| 36 | + # Commit reformatted files back to the PR branch. |
| 37 | + contents: write |
| 38 | + # Create and normalize migration state labels. |
| 39 | + issues: write |
| 40 | + # Read/update pull request metadata and comments. |
| 41 | + pull-requests: write |
| 42 | + |
| 43 | +jobs: |
| 44 | + black-migration: |
| 45 | + name: Migrate Black |
| 46 | + # Skip if it was triggered by the merge queue. We only need the workflow to |
| 47 | + # be executed to meet the "Required check" condition for merging, but we |
| 48 | + # don't need to actually run the job, having the job present as Skipped is |
| 49 | + # enough. |
| 50 | + if: | |
| 51 | + github.event_name == 'pull_request_target' && |
| 52 | + github.actor == 'dependabot[bot]' && |
| 53 | + contains(github.event.pull_request.title, 'Bump black from ') |
| 54 | + runs-on: ubuntu-24.04 |
| 55 | + steps: |
| 56 | + - name: Generate token |
| 57 | + id: create-app-token |
| 58 | + uses: actions/create-github-app-token@f8d387b68d61c58ab83c6c016672934102569859 # v3.0.0 |
| 59 | + with: |
| 60 | + app-id: ${{ secrets.FREQUENZ_AUTO_DEPENDABOT_APP_ID }} |
| 61 | + private-key: ${{ secrets.FREQUENZ_AUTO_DEPENDABOT_APP_PRIVATE_KEY }} |
| 62 | + # Push reformatted files to the PR branch. |
| 63 | + permission-contents: write |
| 64 | + # Create and normalize migration state labels. |
| 65 | + permission-issues: write |
| 66 | + # Read/update pull request metadata and labels. |
| 67 | + permission-pull-requests: write |
| 68 | + - name: Migrate |
| 69 | + uses: frequenz-floss/gh-action-dependabot-migrate@27763fb5eb56476d91abe00132e8a0614171f92f # v1.2.0 |
| 70 | + with: |
| 71 | + migration-script: | |
| 72 | + import os |
| 73 | + import subprocess |
| 74 | + import sys |
| 75 | +
|
| 76 | + version = os.environ["MIGRATION_VERSION"].lstrip("v") |
| 77 | + subprocess.run( |
| 78 | + [sys.executable, "-Im", "pip", "install", f"black=={version}"], |
| 79 | + check=True, |
| 80 | + ) |
| 81 | + subprocess.run([sys.executable, "-Im", "black", "."], check=True) |
| 82 | + token: ${{ steps.create-app-token.outputs.token }} |
| 83 | + auto-merge-on-changes: "false" |
| 84 | + version-iteration: "false" |
| 85 | + sign-commits: "true" |
| 86 | + auto-merged-label: "tool:auto-merged" |
| 87 | + migrated-label: "tool:black:migration:executed" |
| 88 | + intervention-pending-label: "tool:black:migration:intervention-pending" |
| 89 | + intervention-done-label: "tool:black:migration:intervention-done" |
0 commit comments