From 7cda1dab9463b9d408ca1b7d3a22a1da6e3e844f Mon Sep 17 00:00:00 2001 From: Simon Prochazka Date: Wed, 11 Sep 2019 11:31:58 +0200 Subject: [PATCH] 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 --- README.md | 17 ++++++++++++++++- www/content/index.md | 18 +++++++++++++++++- 2 files changed, 33 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 21bc4697..a82494a1 100644 --- a/README.md +++ b/README.md @@ -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/commitsar@v0.6.3 (substitute for current version) +``` + ##### Example for CircleCI: diff --git a/www/content/index.md b/www/content/index.md index fa7ccb38..49a756b4 100644 --- a/www/content/index.md +++ b/www/content/index.md @@ -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/commitsar@v0.6.3 (substitute for current version) +``` ## Example for CircleCI