name: Commit Message Check

on:

pull_request:

types:

- opened

- reopened

- synchronize

env:

error_msg: |

See the document below for help on formatting commits for the project.

https://github.com/kata-containers/community/blob/master/CONTRIBUTING.md#patch-format

jobs:

commit-message-check:

runs-on: ubuntu-latest

name: Commit Message Check

steps:

- name: Get PR Commits

id: 'get-pr-commits'

uses: tim-actions/[email protected]

with:

token: ${{ secrets.GITHUB_TOKEN }}

- name: DCO Check

uses: tim-actions/dco@2fd0504dc0d27b33f542867c300c60840c6dcb20

with:

commits: ${{ steps.get-pr-commits.outputs.commits }}

- name: Commit Body Missing Check

if: ${{ success() || failure() }}

uses: tim-actions/[email protected]

with:

commits: ${{ steps.get-pr-commits.outputs.commits }}

- name: Check Subject Line Length

if: ${{ success() || failure() }}

uses: tim-actions/[email protected]

with:

commits: ${{ steps.get-pr-commits.outputs.commits }}

pattern: '^.{0,75}(\n.*)*$'

error: 'Subject too long (max 75)'

post_error: ${{ env.error_msg }}

- name: Check Body Line Length

if: ${{ success() || failure() }}

uses: tim-actions/[email protected]

with:

commits: ${{ steps.get-pr-commits.outputs.commits }}

# Notes:

#

# - The subject line is not enforced here (see other check), but has

# to be specified at the start of the regex as the action is passed

# the entire commit message.

#

# - Body lines *can* be longer than the maximum if they start

# with a non-alphabetic character.

#

# This allows stack traces, log files snippets, emails, long URLs,

# etc to be specified. Some of these naturally "work" as they start

# with numeric timestamps or addresses. Emails can but quoted using

# the normal ">" character, markdown bullets ("-", "*") are also

# useful for lists of URLs, but it is always possible to override

# the check by simply space indenting the content you need to add.

#

# - A SoB comment can be any length (as it is unreasonable to penalise

# people with long names/email addresses :)

pattern: '^. (\n([a-zA-Z].{0,149}|[^a-zA-Z\n].*|Signed-off-by:.*|)) $'

error: 'Body line too long (max 72)'

post_error: ${{ env.error_msg }}

- name: Check Fixes

if: ${{ success() || failure() }}

uses: tim-actions/[email protected]

with:

commits: ${{ steps.get-pr-commits.outputs.commits }}

pattern: '\s*Fixes\s*:?\s*(#\d |github\.com\/kata-containers\/[a-z-.]*#\d )|^\s*release\s*:'

flags: 'i'

error: 'No "Fixes" found'

post_error: ${{ env.error_msg }}

one_pass_all_pass: 'true'

- name: Check Subsystem

if: ${{ success() || failure() }}

uses: tim-actions/[email protected]

with:

commits: ${{ steps.get-pr-commits.outputs.commits }}

pattern: '^[\s\t]*[^:\s\t] [\s\t]*:'

error: 'Failed to find subsystem in subject'

post_error: ${{ env.error_msg }}