Merge pull request #444 from jrdnbradford/add-circle-ci-hook

Add CircleCI `pre-commit` hook

Author: sirosen

.pre-commit-hooks.yaml

@@ -68,6 +68,16 @@
     )$
   types_or: [json,yaml]
 
+# this hook is autogenerated from a script
+# to modify this hook, update `src/check_jsonschema/catalog.py`
+# and run `make generate-hooks` or `tox run -e generate-hooks-config`
+- id: check-circle-ci
+  name: Validate CircleCI config
+  description: 'Validate CircleCI config against the schema provided by SchemaStore'
+  entry: check-jsonschema --builtin-schema vendor.circle-ci
+  language: python
+  files: ^\.circleci/config\.(yml|yaml)$
+
 # this hook is autogenerated from a script
 # to modify this hook, update `src/check_jsonschema/catalog.py`
 # and run `make generate-hooks` or `tox run -e generate-hooks-config`

docs/precommit_usage.rst

@@ -99,6 +99,20 @@ Validate Buildkite Pipelines against the schema provided by Buildkite
         - id: check-buildkite
 
 
+``check-circle-ci``
+~~~~~~~~~~~~~~~~~~~
+
+Validate CircleCI config against the schema provided by SchemaStore
+
+.. code-block:: yaml
+    :caption: example config
+
+    - repo: https://github.com/python-jsonschema/check-jsonschema
+      rev: 0.28.5
+      hooks:
+        - id: check-circle-ci
+
+
 ``check-cloudbuild``
 ~~~~~~~~~~~~~~~~~~~~
 

docs/usage.rst

@@ -90,6 +90,7 @@ SchemaStore and other sources:
 - ``vendor.bamboo-spec``
 - ``vendor.bitbucket-pipelines``
 - ``vendor.buildkite``
+- ``vendor.circle-ci``
 - ``vendor.cloudbuild``
 - ``vendor.dependabot``
 - ``vendor.drone-ci``