Skip to content

Commit 64f10fd

Browse files
committed
DOC: update readme with configuration example
1 parent 75effd2 commit 64f10fd

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

check-commit/README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,46 @@ steps:
5454
uses: docker://haproxytech/check-commit:TAG
5555
```
5656
Here we instruct `checkout@v2` action to fetch last 10 commits (by default it fetches only last one) which is required in case of checking multiple commits.
57+
58+
## Example configuration
59+
60+
If a configuration file (`.check-commit.yml`) is not available in the running directory, a built-in failsafe configuration identical to the one below is used.
61+
62+
```yaml
63+
---
64+
HelpText: "Please refer to https://github.com/haproxy/haproxy/blob/master/CONTRIBUTING#L632"
65+
PatchScopes:
66+
HAProxy Standard Scope:
67+
- MINOR
68+
- MEDIUM
69+
- MAJOR
70+
- CRITICAL
71+
PatchTypes:
72+
HAProxy Standard Patch:
73+
Values:
74+
- BUG
75+
- BUILD
76+
- CLEANUP
77+
- DOC
78+
- LICENSE
79+
- OPTIM
80+
- RELEASE
81+
- REORG
82+
- TEST
83+
- REVERT
84+
Scope: HAProxy Standard Scope
85+
HAProxy Standard Feature Commit:
86+
Values:
87+
- MINOR
88+
- MEDIUM
89+
- MAJOR
90+
- CRITICAL
91+
TagOrder:
92+
- PatchTypes:
93+
- HAProxy Standard Patch
94+
- HAProxy Standard Feature Commit
95+
```
96+
97+
### Optional parameters
98+
99+
The program accepts an optional parameter to specify the location (path) of the base of the git repository.

0 commit comments

Comments
 (0)