Skip to content
check-circle

GitHub Action

Check PR commits signed off

v1.0.0 Latest version

Check PR commits signed off

check-circle

Check PR commits signed off

Checks for a sign-off in every commit in a pull request

Installation

Copy and paste the following snippet into your .yml file.

              
- name: Check PR commits signed off

              
  uses: live627/check-pr-signoff-action@v1.0.0
Learn more about this action in live627/check-pr-signoff-action

Choose a version

GitHub Action: Check PR commits signed off

Checks for a sign-off in every commit in a pull request and adds a comment if a commit was detected without one.

Inputs

Input Description Default Required
token GitHub token for commenting on PRs, defaults to using secrets.GITHUB_TOKEN ${{ github.token }} false

Outputs

None

Requirements

This action must be triggered from a pull request event: on: [pull_request]. You can also use any pull_request activity type. For information on those activity types, see the GitHub documentation.

Example Usage

name: Find signed commits

on:
  pull_request_target:

jobs:
  check-sign-off:
    name: Write comment if unsigned commits found
    env:
      FORCE_COLOR: 1
    runs-on: ubuntu-latest

    steps:
      - uses: live627/check-pr-signoff-action@v1
        with:
          token: ${{ secrets.GITHUB_TOKEN }}