pre-commit.yml 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. name: pre-commit
  2. on:
  3. push:
  4. branches:
  5. - master
  6. pull_request:
  7. # Cancel in progress workflows on pull_requests.
  8. # https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-a-fallback-value
  9. concurrency:
  10. group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  11. cancel-in-progress: true
  12. defaults:
  13. run:
  14. # the default default is:
  15. # bash --noprofile --norc -eo pipefail {0}
  16. shell: bash --noprofile --norc -eo pipefail -ux {0}
  17. # hack for https://github.com/actions/cache/issues/810#issuecomment-1222550359
  18. env:
  19. SEGMENT_DOWNLOAD_TIMEOUT_MINS: 3
  20. # workaround: secrets cannot be directly referenced in `if`
  21. # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#example-using-secrets
  22. SECRET_ACCESS: ${{toJSON(secrets.SENTRY_INTERNAL_APP_PRIVATE_KEY != null)}}
  23. jobs:
  24. lint:
  25. name: pre-commit lint
  26. runs-on: ubuntu-22.04
  27. timeout-minutes: 10
  28. steps:
  29. - # get a non-default github token so that any changes are verified by CI
  30. if: env.SECRET_ACCESS == 'true'
  31. uses: getsentry/action-github-app-token@d4b5da6c5e37703f8c3b3e43abb5705b46e159cc # v3.0.0
  32. id: token
  33. with:
  34. app_id: ${{ vars.SENTRY_INTERNAL_APP_ID }}
  35. private_key: ${{ secrets.SENTRY_INTERNAL_APP_PRIVATE_KEY }}
  36. - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
  37. - name: Get changed files
  38. id: changes
  39. uses: dorny/paths-filter@0bc4621a3135347011ad047f9ecf449bf72ce2bd # v3.0.0
  40. with:
  41. # Enable listing of files matching each filter.
  42. # Paths to files will be available in `${FILTER_NAME}_files` output variable.
  43. list-files: json
  44. # It doesn't make sense to lint deleted files.
  45. # Therefore we specify we are only interested in added or modified files.
  46. filters: |
  47. all:
  48. - added|modified: '**/*'
  49. - uses: getsentry/action-setup-venv@f0daafa9688e48f939cace0378a46f2d422bd81f # v2.0.0
  50. with:
  51. python-version: 3.11.6
  52. cache-dependency-path: |
  53. requirements-dev.txt
  54. requirements-dev-frozen.txt
  55. install-cmd: python3 -m tools.hack_pip && pip install -r requirements-dev.txt -c requirements-dev-frozen.txt
  56. - uses: actions/cache@13aacd865c20de90d75de3b17ebe84f7a17d57d2 # v4.0.0
  57. with:
  58. path: ~/.cache/pre-commit
  59. key: cache-epoch-1|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml') }}
  60. - name: Setup pre-commit
  61. # We don't use make setup-git because we're only interested in installing
  62. # requirements-dev.txt as a fast path.
  63. # We don't need pre-commit install --install-hooks since we're just interested
  64. # in running the hooks.
  65. run: |
  66. pre-commit install-hooks
  67. - name: Run pre-commit on PR commits
  68. run: |
  69. jq '.[]' --raw-output <<< '${{steps.changes.outputs.all_files}}' |
  70. # Run pre-commit to lint and format check files that were changed (but not deleted) compared to master.
  71. xargs pre-commit run --files
  72. - name: Apply any pre-commit fixed files
  73. # note: this runs "always" or else it's skipped when pre-commit fails
  74. if: env.SECRET_ACCESS == 'true' && startsWith(github.ref, 'refs/pull') && always()
  75. uses: getsentry/action-github-commit@748c31dd78cffe76f51bef49a0be856b6effeda7 # v1.1.0
  76. with:
  77. github-token: ${{ steps.token.outputs.token }}
  78. message: ':hammer_and_wrench: apply pre-commit fixes'