Skip to content

Commit

Permalink
ci(pre-commit): Enforce that the pre-commit checks are run before merge
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasssvaz committed Apr 17, 2024
1 parent a45b5af commit 62ef661
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 3 deletions.
40 changes: 40 additions & 0 deletions .github/workflows/pre-commit-status.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Report Pre-commit Check Status

on:
pull_request_target:
types: [opened, reopened, synchronize, labeled, unlabeled]

permissions:
statuses: write

jobs:
report-run:
name: Check if the PR has run the pre-commit checks
runs-on: ubuntu-latest
steps:
- name: Wait for pre-commit checks to complete
uses: lucasssvaz/wait-on-workflow@v1
id: wait-on-workflow
with:
workflow: pre-commit.yml
sha: ${{ github.event.pull_request.head.sha || github.sha }}

- name: Report success
if: |
contains(github.event.pull_request.labels.*.name, 'Status: Pending Merge') &&
steps.wait-on-workflow.outputs.conclusion == 'success'
uses: conda/actions/set-commit-status@v24.2.0
with:
context: "Pre-commit checks"
state: success
description: All pre-commit checks passed

- name: Report pending
if: |
!contains(github.event.pull_request.labels.*.name, 'Status: Pending Merge') ||
steps.wait-on-workflow.outputs.conclusion != 'success'
uses: conda/actions/set-commit-status@v24.2.0
with:
context: "Pre-commit checks"
state: pending
description: The pre-commit checks need to be successful before merging
6 changes: 3 additions & 3 deletions .github/workflows/pre-commit.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
name: Pre-commit check
name: Pre-commit hooks

on:
pull_request:
types: [opened, reopened, synchronize, labeled]
types: [opened, reopened, synchronize, labeled, unlabeled]

jobs:
lint:
if: |
contains(github.event.pull_request.labels.*.name, 'Status: Pending Merge')
name: Checking if any fixes are needed
name: Check if fixes are needed
runs-on: ubuntu-latest
steps:
- name: Checkout latest commit
Expand Down

0 comments on commit 62ef661

Please sign in to comment.