diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 2ad2c569..6dcd90b6 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,13 +1 @@ - - -What I did: - - -## Checklist - -* [ ] all commits are `--signoff` (Why? See CONTRIBUTING.md) -* [ ] No `!fixup` commits in the PR -* [ ] I ran `cargo check --all --tests` -* [ ] I ran `cargo test` -* [ ] I ran `cargo clippy` - + diff --git a/.github/workflows/commit-lint.yml b/.github/workflows/commit-lint.yml index 309d637d..56aeac96 100644 --- a/.github/workflows/commit-lint.yml +++ b/.github/workflows/commit-lint.yml @@ -6,7 +6,7 @@ name: Pull Request Checks jobs: commit-lint: runs-on: ubuntu-latest - if: github.event_name == 'pull_request' + steps: - uses: actions/checkout@v3 with: @@ -15,4 +15,10 @@ jobs: with: python-version: '3.x' - run: pip install gitlint - - run: gitlint --commits $(git merge-base origin/master HEAD)..HEAD + - run: | + gitlint \ + -c general.ignore-fixup-commits=false \ + -c general.ignore-fixup-amend-commits=false \ + -c general.ignore-squash-commits=false \ + --contrib contrib-body-requires-signed-off-by,contrib-disallow-cleanup-commits \ + --commits "$(git merge-base origin/master HEAD)..HEAD" diff --git a/.github/workflows/fixupblock.yml b/.github/workflows/fixupblock.yml deleted file mode 100644 index 8e2f1c3e..00000000 --- a/.github/workflows/fixupblock.yml +++ /dev/null @@ -1,12 +0,0 @@ -on: [pull_request] - -name: Git Checks - -jobs: - block-fixup: - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v3.1.0 - - name: Block Fixup Commit Merge - uses: 13rac1/block-fixup-merge-action@v2.0.0 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 109d6c05..8314bdbf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,16 @@ This file describes how you can contribute to butido. +## Checklist + +Those checks are performed/enforced via CI but you probably want to go over the +checklist before submitting a PR to avoid unnecessary PR/CI iteration cycles: + +* [ ] All commits are signed off (`--signoff` - Why? See below) +* [ ] No `!fixup` (etc.) commits +* [ ] I ran `cargo check --all --tests` +* [ ] I ran `cargo test` +* [ ] I ran `cargo clippy` ## Reporting issues / Questions