-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📝 Add initial documentation on how to use (#3)
- Loading branch information
1 parent
2160c9d
commit ac82acf
Showing
1 changed file
with
28 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |