generated from fallion/go-template
-
-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- removes false claim that the binary needs to be in same folder as git repository - adds example usage with Github actions Closes #93
- Loading branch information
Showing
2 changed files
with
33 additions
and
2 deletions.
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 |
---|---|---|
|
@@ -14,7 +14,22 @@ Tool to make sure your commits are compliant with [conventional commits](https:/ | |
|
||
Commitsar is shipped as a Dockerfile. This is the easiest way to add it to your CI. | ||
|
||
**Important: Commitsar currently needs to be in the same folder as the git repository you want checked** | ||
**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** | ||
|
||
#### Github action | ||
|
||
Checkout git in order to get commits and master branch | ||
``` | ||
- name: Check out code into the Go module directory | ||
uses: actions/checkout@v1 | ||
``` | ||
|
||
Run the Commitsar action | ||
``` | ||
- name: Commitsar Action | ||
uses: commitsar-app/[email protected] (substitute for current version) | ||
``` | ||
|
||
|
||
##### Example for CircleCI: | ||
|
||
|
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 |
---|---|---|
|
@@ -11,7 +11,23 @@ Tool to make sure your commits are compliant with [conventional commits](https:/ | |
|
||
Commitsar is shipped as a Dockerfile. This is the easiest way to add it to your CI. | ||
|
||
**Important: Commitsar currently needs to be in the same folder as the git repository you want checked** | ||
**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** | ||
|
||
#### Github action | ||
|
||
> Github actions | ||
Checkout git in order to get commits and master branch | ||
``` | ||
- name: Check out code into the Go module directory | ||
uses: actions/checkout@v1 | ||
``` | ||
|
||
Run the Commitsar action | ||
``` | ||
- name: Commitsar Action | ||
uses: commitsar-app/[email protected] (substitute for current version) | ||
``` | ||
|
||
## Example for CircleCI | ||
|
||
|