Skip to content

Commit 871781e

Browse files
committed
Add Jira example docs
1 parent 0331b3d commit 871781e

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

+25
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,31 @@ jobs:
2525
uses: aschbacd/[email protected]
2626
```
2727
28+
### Example configuration for Jira
29+
30+
If you want to allow Jira issue ids at the beginning of the commit message / pull request title you
31+
can use the following configuration. With this configuration commit messages / pull request titles
32+
like `[GLA-1] Add sample file` as well as `Add sample file` will be valid.
33+
34+
```yaml
35+
name: Linters
36+
37+
on:
38+
pull_request: {}
39+
push: {}
40+
41+
jobs:
42+
gitlint:
43+
runs-on: ubuntu-latest
44+
name: GitLint
45+
steps:
46+
- name: Lint commits, branches, and pull requests
47+
uses: aschbacd/[email protected]
48+
with:
49+
re-commit-message-subject: ^(\[[A-Z]+\-[0-9]+\] )?[A-Z].*((?!\.).)$
50+
re-pull-request-title: ^(\[[A-Z]+\-[0-9]+\] )?[A-Z].*((?!\.).)$
51+
```
52+
2853
## Customization
2954

3055
The following input keys can be used in your GitHub Actions workflow (shown above).

0 commit comments

Comments
 (0)