Skip to content

Commit

Permalink
Check for fixup commits on CI
Browse files Browse the repository at this point in the history
I keep merging PRs that still have fixup commits on them! This will make
it impossible to do so
  • Loading branch information
jesseduffield committed Jul 13, 2024
1 parent 73bcbe4 commit c76bc48
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -219,3 +219,25 @@ jobs:
CODACY_PROJECT_TOKEN=${{ secrets.CODACY_PROJECT_TOKEN }} \
bash <(curl -Ls https://coverage.codacy.com/get.sh) report \
--force-coverage-parser go -r coverage.out
check-for-fixups:
runs-on: ubuntu-latest
if: github.ref != 'refs/heads/master'
steps:
# See https://github.com/actions/checkout/issues/552#issuecomment-1167086216
- name: "PR commits + 1"
run: echo "PR_FETCH_DEPTH=$(( ${{ github.event.pull_request.commits }} + 1 ))" >> "${GITHUB_ENV}"

- name: "Checkout PR branch and all PR commits"
uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.ref }}
fetch-depth: ${{ env.PR_FETCH_DEPTH }}

- name: "Fetch the other branch with enough history for a common merge-base commit"
run: |
git fetch origin ${{ github.event.pull_request.base.ref }}
- name: Check for fixups
run: |
./scripts/check-for-fixups.sh ${{ github.event.pull_request.base.ref }}
25 changes: 25 additions & 0 deletions scripts/check_for_fixups.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
#!/bin/sh

base_ref=$1

# Determine the base commit
base_commit=$(git merge-base HEAD origin/"$base_ref")

# Check if base_commit is set correctly
if [ -z "$base_commit" ]; then
echo "Failed to determine base commit."
exit 1
fi
echo "Base commit: $base_commit"

# Get commits with "fixup!" in the message from base_commit to HEAD
commits=$(git log -i -P --grep "fixup\!" --format="%h %s" "$base_commit..HEAD")

if [ -z "$commits" ]; then
echo "No fixup commits found."
exit 0
else
echo "Fixup commits found:"
echo "$commits"
exit 1
fi

0 comments on commit c76bc48

Please sign in to comment.