From f343af42184f68d32474004360fe7e15bf03839e Mon Sep 17 00:00:00 2001 From: Adrian Smijulj Date: Thu, 11 Jun 2020 09:55:51 +0200 Subject: [PATCH] chore: update README --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dd19e96..25b0d0a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,11 @@ # Conventional Commits GitHub Action -A simple GitHub action that makes sure all commit messages are following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) specification. +A simple GitHub action that makes sure all commit messages are following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) specification. If not, workflow will fail. + +Typically, you would make these check in a pre-commit hook (for example, using something like [Commitlint](https://commitlint.js.org/)), but those can be easily skipped, hence this GitHub action. ### Usage +Latest version: `v1.0.1` ```yml name: My Workflow