Skip to content

Commit

Permalink
📝 Add initial documentation on how to use (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
georgepstaylor authored May 4, 2024
1 parent 2160c9d commit ac82acf
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,29 @@
# gitmoji-enforcer


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

It will leave a comment on the PR like so:
https://github.com/georgepstaylor/gitmoji-pr-title-enforcer/pull/2#issuecomment-2094373552
or
https://github.com/georgepstaylor/gitmoji-pr-title-enforcer/pull/2#issuecomment-2094373635
Depending on whether the PR title is valid or not.

## Usage
```yaml
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.

0 comments on commit ac82acf

Please sign in to comment.