https://github.com/live627/check-pr-signoff-action

Checks for a sign-off in every commit in a pull request and adds a comment if a commit was detected without one.
https://github.com/live627/check-pr-signoff-action

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/live627/check-pr-signoff-action
• Owner: live627
• License: mit
• Created: 2021-09-20T03:04:08.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-09-20T07:18:08.000Z (over 3 years ago)
• Last Synced: 2025-03-13T15:41:20.231Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 115 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# 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](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows#pull-request-event-pull_request).

## Example Usage

```yaml

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 }}

```