Skip to content

Commit

Permalink
docs: Improve readme
Browse files Browse the repository at this point in the history
- 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
fallion committed Sep 11, 2019
1 parent 54f834b commit 7cda1da
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 2 deletions.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
18 changes: 17 additions & 1 deletion www/content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 7cda1da

Please sign in to comment.