README.md

gitmoji-pr-title-enforcer

A simple action to enforce the use of gitmoji in PR titles.

It will leave a comment on the PR like so: #2 (comment) or #2 (comment) Depending on whether the PR title is valid or not.

Usage

name: Enforce gitmoji PR
on:
  pull_request:
    types: [opened, edited, reopened, synchronize]
permissions:
  pull-requests: write
jobs:
  gitmoji-pr-title:
    runs-on: ubuntu-latest
    steps:
      - name: Enforce gitmoji PR title
        uses: georgepstaylor/[email protected]
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Using the above example verbatim, you can use the job title gitmoji-pr-title as a required check.