https://github.com/profusion/check-pr-commits-authors-action

https://github.com/profusion/check-pr-commits-authors-action

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/profusion/check-pr-commits-authors-action
• Owner: profusion
• Created: 2023-04-17T13:05:42.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-04-19T19:39:55.000Z (about 3 years ago)
• Last Synced: 2025-11-10T20:08:34.345Z (8 months ago)
• Size: 8.79 KB
• Stars: 0
• Watchers: 18
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# check-pr-commits-authors-action

Checks a pull request commits authors according to the email domain. It pass if it's not triggered on a pull request event.

## Inputs

### `EMAIL_PATTERN`

Required email pattern. For example: "^.*@required\\.com$".

### `IGNORED_EMAIL_PATTERN`

Email pattern to be ignored on check.. For example: "^.*@ignored\\.com$".

## Env

### `GITHUB_TOKEN`

Required github token to read the repository pull request.

## Usage example

```yaml

name: Check PR commits authors example

on:

  pull_request:

jobs:

  check-commits-authors:

    env:

      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

    steps:

      - uses: profusion/check-pr-commits-authors-action@main

        with:

          EMAIL_PATTERN: ${{ vars.EMAIL_PATTERN }}

          IGNORED_EMAIL_PATTERN: ${{ vars.IGNORED_EMAIL_PATTERN }} # this one is not required

```

## Running example

### `Triggered on a no pull request related event`

![Screenshot 2023-04-19 at 13 48 42](https://user-images.githubusercontent.com/61801642/233144933-74611cac-3136-4b4c-a4cd-4c46c686f0de.png)

### `At least one invalid commit author`

![Screenshot 2023-04-19 at 12 38 07](https://user-images.githubusercontent.com/61801642/233127631-defe7572-e0f9-43d6-8af1-a99e2213ea23.png)

### `No invalid commit author`

![Screenshot 2023-04-19 at 12 46 17](https://user-images.githubusercontent.com/61801642/233129773-fb3748b5-ccaf-4756-a671-d1fc07cd3f2f.png)