Skip to content

Commit

Permalink
OAK-11269 add dedicated workflow for checking commit messages
Browse files Browse the repository at this point in the history
  • Loading branch information
kwin committed Nov 18, 2024
1 parent 1294f24 commit 503c0bb
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .commit-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# format as outlined in https://github.com/commit-check/commit-check/blob/main/.commit-check.yml
# further information in https://github.com/commit-check/commit-check/blob/main/README.rst
checks:
- check: message
regex: '^OAK-\d+\s\S+.*'
error: "The commit message must start with 'OAK-<ID> ' followed by some descriptive text"
suggest: Please check your commit message whether it matches above regex

- check: author_name
regex: ^[A-Za-z ,.\'-]+$|.*(\[bot])
error: The committer name seems invalid
suggest: run command `git config user.name "Your Name"`

- check: author_email
regex: ^.+@.+$
error: The committer email seems invalid
suggest: run command `git config user.email yourname@example.com`
32 changes: 32 additions & 0 deletions .github/workflows/commit-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Commit Check

on:
pull_request:
branches: 'trunk'

jobs:
commit-check:
runs-on: ubuntu-latest
permissions: # use permissions because of use pr-comments
contents: read
pull-requests: write
steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.sha }} # checkout PR HEAD commit
fetch-depth: 0 # required for merge-base check
# https://github.com/commit-check
# must be pinned due to https://infra.apache.org/github-actions-policy.html
- uses: commit-check/commit-check-action@8d507e12899a9feb405c3ed546252ff9508724e0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # use GITHUB_TOKEN because of use pr-comments
with:
# check commit message formatting convention
message: true
branch: true
author-name: true
author-email: true
commit-signoff: false
merge-base: false
job-summary: true
pr-comments: ${{ github.event_name == 'pull_request' }}

0 comments on commit 503c0bb

Please sign in to comment.