README.md

slicer-check-commit-message-action

This GitHub composite action verifies that commit messages conform to the Slicer commit style guidelines.

Usage

To automatically enforce the Slicer commit message style during pull requests or pushes to the main branch, create a workflow file at .github/workflows/commit-message.yml with the following content:

name: "Commit Message Check"
on:
  pull_request:
    types:
      - opened
      - edited
      - reopened
      - synchronize
  push:
    branches:
      - main

permissions:
  contents: read
  pull-requests: read

jobs:
  check-commit-message:
    runs-on: ubuntu-latest
    steps:
      - name: Check Commit Message
        uses: slicer/[email protected]
        with:
          token: ${{ secrets.GITHUB_TOKEN }}

This workflow will trigger commit message checks on relevant pull request events or when changes are pushed to the main branch.

History

This action was originally implemented by @jamesobutler, @pieper and @jcfr in the Slicer repository under .github/workflows/commit-message.yml.