From cbc3d50cea7154ed11a00bacb0419c1736bb7a35 Mon Sep 17 00:00:00 2001 From: Stefan Zweifel Date: Sun, 13 Sep 2020 14:11:23 +0200 Subject: [PATCH] Add Badge --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index b1407d0..a455ca2 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ > The GitHub Action for committing files for the 80% use case. +![tests](https://github.com/stefanzweifel/git-auto-commit-action/workflows/tests/badge.svg) + This GitHub Action automatically commits files which have been changed during a Workflow run and pushes the commit back to GitHub. The default committer is "GitHub Actions ", and the default author of the commit is "Your GitHub Username ". @@ -233,6 +235,14 @@ Note: If you're working in an organisation and you don't want to create the PAT This is due to limitations set up by GitHub, [commits of this Action do not trigger new Workflow runs](#commits-of-this-action-do-not-trigger-new-workflow-runs). +## Running the tests + +The package has tests written in [bats](https://github.com/bats-core/bats-core). You can run them with the following command. + +```shell +npm run tests +``` + ## Versioning We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/stefanzweifel/git-auto-commit-action/tags).