From d520a4873ee6c2c13035926a98746a0d0e20f087 Mon Sep 17 00:00:00 2001 From: Martin Wimpress Date: Sun, 5 May 2024 10:41:53 +0100 Subject: [PATCH 1/2] ci: add lint-pr.yml; conventional commits specification checker --- .github/workflows/lint-pr.yml | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 .github/workflows/lint-pr.yml diff --git a/.github/workflows/lint-pr.yml b/.github/workflows/lint-pr.yml new file mode 100644 index 0000000000..d4142fa430 --- /dev/null +++ b/.github/workflows/lint-pr.yml @@ -0,0 +1,31 @@ +name: "Lint Pull Request 🐙" + +on: + pull_request_target: + types: + - opened + - edited + - synchronize + +permissions: + pull-requests: write + +jobs: + main: + name: Validate pull request title + runs-on: ubuntu-22.04 + steps: + - uses: amannn/action-semantic-pull-request@v5 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + # Opt-in to using the special "[WIP]" state + # This will prevent the PR title from being validated, and pull + # request checks will remain pending. + wip: true + # If the PR only contains a single commit, the action will validate that + # it matches the configured pattern. + validateSingleCommit: true + # Related to `validateSingleCommit` you can opt-in to validate that the PR + # title matches a single commit to avoid confusion. + validateSingleCommitMatchesPrTitle: true From 103dd158d65d20ba01d1f56531c19ca8950a37ba Mon Sep 17 00:00:00 2001 From: Martin Wimpress Date: Sun, 5 May 2024 10:40:45 +0100 Subject: [PATCH 2/2] docs: add note about using conventional commits spec --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 426678b13b..2cbcf3f9fe 100644 --- a/README.md +++ b/README.md @@ -129,4 +129,5 @@ We welcome contributions to Quickemu. - Submit [Quickemu Pull requests](https://github.com/quickemu-project/quickemu/pulls) to fix bugs 🐞 or add new features ✨ + - Commits messages must [conform to the Conventional Commits spcification](https://www.conventionalcommits.org/). - [Sponsor the project](https://github.com/sponsors/flexiondotorg) 💖