Skip to content
This repository was archived by the owner on Dec 6, 2023. It is now read-only.

Commit 166bbd3

Browse files
committed
DOC: adding doc about handling multiple commits
1 parent 0606ccc commit 166bbd3

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This repository contains Github Actions used in CI/CD workflows of [HAProxy Tech
1212
```yaml
1313
steps:
1414
- name: Check out code
15-
uses: actions/checkout@v1
15+
uses: actions/checkout@v2
1616
- name: action-name
1717
uses: docker://haproxytech/action-name:TAG
1818
```
@@ -22,7 +22,7 @@ steps:
2222
```yaml
2323
steps:
2424
- name: Check out code
25-
uses: actions/checkout@v1
25+
uses: actions/checkout@v2
2626
- name: action-name
2727
uses: haproxytech/github-actions/action-name@TAG
2828
```

check-commit/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
This action checks that the commit subject is compliant with the [patch classifying rules](https://github.com/haproxy/haproxy/blob/master/CONTRIBUTING#L632) of HAProxy contribution guidelines. Also it does minimal check for a meaningful message in the commit subject: no less than 20 characters and at least 3 words.
44

5+
By default only the top commit subject is checked.
6+
If the commit subject has the format: `Merge 'commitA-ID' into 'commitB-ID'`, all commit subjects between 'commitA' and 'commitB' will be checked.
7+
58
## Examples
69

710
### Good
@@ -44,7 +47,10 @@ None.
4447
```yaml
4548
steps:
4649
- name: Check out code
47-
uses: actions/checkout@v1
50+
uses: actions/checkout@v2
51+
with:
52+
fetch-depth: 10
4853
- name: check-commit
4954
uses: docker://haproxytech/check-commit:TAG
5055
```
56+
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.

0 commit comments

Comments
 (0)