Merge pull request #515 from edgarrmondragon/compose-spec

Add Compose Spec schema and pre-commit hook

Author: sirosen

.pre-commit-hooks.yaml

@@ -89,6 +89,21 @@
   files: ^cloudbuild\.(yml|yaml|json)$
   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-compose-spec
+  name: Validate Docker Compose files
+  description: 'Validate Docker Compose files against the schema provided by SchemaStore'
+  entry: check-jsonschema --builtin-schema vendor.compose-spec
+  language: python
+  files: >
+    (?x)^(
+      ([^/]*/)*docker-compose(\.[\.a-zA-Z0-9_-]*)*\.(yml|yaml)|
+      ([^/]*/)*compose(\.[\.a-zA-Z0-9_-]*)*\.(yml|yaml)
+    )$
+  types: [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

@@ -127,6 +127,20 @@ Validate Google Cloud Build config against the schema provided by SchemaStore
         - id: check-cloudbuild
 
 
+``check-compose-spec``
+~~~~~~~~~~~~~~~~~~~~~~
+
+Validate Docker Compose files against the schema provided by SchemaStore
+
+.. code-block:: yaml
+    :caption: example config
+
+    - repo: https://github.com/python-jsonschema/check-jsonschema
+      rev: 0.31.0
+      hooks:
+        - id: check-compose-spec
+
+
 ``check-dependabot``
 ~~~~~~~~~~~~~~~~~~~~
 

docs/usage.rst

@@ -92,6 +92,7 @@ SchemaStore and other sources:
 - ``vendor.buildkite``
 - ``vendor.circle-ci``
 - ``vendor.cloudbuild``
+- ``vendor.compose-spec``
 - ``vendor.dependabot``
 - ``vendor.drone-ci``
 - ``vendor.github-actions``