feat(pre-commit-hook): Update documentation and tag (#530)

* feat(pre-commit-hook): Update documentation and tag

.github/workflows/pre-commit.yml

@@ -2,14 +2,18 @@ name: Pre-Commit Hook CI
 on:
   push:
     paths:
-      - 'pre_commit_hooks/**'
-      - 'pre_commit_hooks_tests/**'
-      - '.github/workflows/pre-commit.yml'
+      - pre_commit_hooks/**
+      - pre_commit_hooks_tests/**
+      - .github/workflows/pre-commit.yml
+      - .pre-commit-config.yaml
+      - .pre-commit-hooks.yaml
   pull_request:
     paths:
-      - 'pre_commit_hooks/**'
-      - 'pre_commit_hooks_tests/**'
-      - '.github/workflows/pre-commit.yml'
+      - pre_commit_hooks/**
+      - pre_commit_hooks_tests/**
+      - .github/workflows/pre-commit.yml
+      - .pre-commit-config.yaml
+      - .pre-commit-hooks.yaml
 jobs:
   run-unit-tests-and-lint:
     runs-on: ubuntu-latest

.pre-commit-config.yaml

@@ -1,15 +1,14 @@
-# TODO: Update this to use the release from CFN once merged
 repos:
--   repo: https://github.com/dannyvassallo/cloudformation-guard
-    rev: pre-commit-v0.0.97
+-   repo: https://github.com/aws-cloudformation/cloudformation-guard
+    rev: pre-commit-v0.0.1
     hooks:
         -   id: cfn-guard
             args:
-                - "--operation=validate"
-                - "--rules=guard/resources/validate/rules-dir/"
+                - --operation=validate
+                - --rules=guard/resources/validate/rules-dir/
             files: ^guard/resources/validate/data-dir/.*
         -   id: cfn-guard
             args:
-                - "--operation=test"
-                - "--dir=pre_commit_hooks_tests/resources/"
+                - --operation=test
+                - --dir=pre_commit_hooks_tests/resources/
             files: ^pre_commit_hooks_tests/resources.*

README.md

@@ -43,6 +43,7 @@ Take this [survey](https://amazonmr.au1.qualtrics.com/jfe/form/SV_bpyzpfoYGGuuUl
 * [AWS Rule Registry](#registry)
 * [Use Guard as a Docker Image](#docker)
 * [Use Guard as a CI tool](#ci)
+* [Use Guard as a pre-commit hook](#pre-commit-hook)
 * [Contribute using the DevContainer in VSCode](#devcontainer)
 * [License](#license)
 
@@ -630,6 +631,31 @@ Guard is great for CI checks with the Junit output format, making the process of
 
 [Get the template here!](https://github.com/aws-cloudformation/cloudformation-guard/tree/main/guard-examples/ci/.circleci/config.yml)
 
+## <a name="pre-commit-hook"></a> Use Guard as a pre-commit hook
+
+Guard is available as a pre-commit hook and offers both the `test` and `validate` operations. You can use them by adding a variation of the following configuration to your `.pre-commit-config.yaml` file:
+
+```yaml
+repos:
+-   repo: https://github.com/aws-cloudformation/cloudformation-guard
+    rev: pre-commit-v0.0.1
+    hooks:
+        # Validate
+        -   id: cfn-guard
+            args:
+                - --operation=validate # Specify the validate operation
+                - --rules=path/to/rules/ # Rules directory
+            files: ^path/to/data/.* # Directory to watch for changes and validate against
+        # Test
+        -   id: cfn-guard
+            args:
+                - --operation=test # Specify the test operation
+                - --dir=path/to/resources/ # Directory that contains rules & their tests
+            files: ^path/to/resources.* # Same directory supplied to the --dir arg so that rule and test file changes trigger a run
+```
+
+**NOTE**: The args for the pre-commit hook are not identical to the flags you would pass directly to Guard. In the case of this hook, you cannot pass a `data` flag to `validate` as it depends on the `filenames` from the hook and you can only use the `dir` flag for the `test` hook.
+
 ## <a name="devcontainer"></a> Contribute using the DevContainer in VSCode
 
 ### Setup