Skip to content

Commit 7cda1da

Browse files
author
Simon Prochazka
committed
docs: Improve readme
- removes false claim that the binary needs to be in same folder as git repository - adds example usage with Github actions Closes #93
1 parent 54f834b commit 7cda1da

File tree

2 files changed

+33
-2
lines changed

2 files changed

+33
-2
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,22 @@ Tool to make sure your commits are compliant with [conventional commits](https:/
1414

1515
Commitsar is shipped as a Dockerfile. This is the easiest way to add it to your CI.
1616

17-
**Important: Commitsar currently needs to be in the same folder as the git repository you want checked**
17+
**Important: Commitsar currently needs to be run in the same folder as the git repository you want checked, currently no override is provided for setting path to git repo see https://github.com/commitsar-app/commitsar/issues/93**
18+
19+
#### Github action
20+
21+
Checkout git in order to get commits and master branch
22+
```
23+
- name: Check out code into the Go module directory
24+
uses: actions/checkout@v1
25+
```
26+
27+
Run the Commitsar action
28+
```
29+
- name: Commitsar Action
30+
uses: commitsar-app/commitsar@v0.6.3 (substitute for current version)
31+
```
32+
1833

1934
##### Example for CircleCI:
2035

www/content/index.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,23 @@ Tool to make sure your commits are compliant with [conventional commits](https:/
1111

1212
Commitsar is shipped as a Dockerfile. This is the easiest way to add it to your CI.
1313

14-
**Important: Commitsar currently needs to be in the same folder as the git repository you want checked**
14+
**Important: Commitsar currently needs to be run in the same folder as the git repository you want checked, currently no override is provided for setting path to git repo see https://github.com/commitsar-app/commitsar/issues/93**
15+
16+
#### Github action
17+
18+
> Github actions
19+
20+
Checkout git in order to get commits and master branch
21+
```
22+
- name: Check out code into the Go module directory
23+
uses: actions/checkout@v1
24+
```
25+
26+
Run the Commitsar action
27+
```
28+
- name: Commitsar Action
29+
uses: commitsar-app/commitsar@v0.6.3 (substitute for current version)
30+
```
1531

1632
## Example for CircleCI
1733

0 commit comments

Comments
 (0)