Merge pull request #594 from vivodi/issue-forms

feat: Add GitHub issue forms schema and pre-commit hook

Author: sirosen

.pre-commit-hooks.yaml

@@ -141,6 +141,20 @@
     )$
   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`
+- id: check-github-issue-forms
+  name: Validate GitHub issue forms
+  description: 'Validate GitHub issue forms against the schema provided by SchemaStore'
+  entry: check-jsonschema --builtin-schema vendor.github-issue-forms
+  language: python
+  files: >
+    (?x)^(
+      ^\.github/ISSUE_TEMPLATE/(?!config\.ya?ml$).+$
+    )$
+  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`

CHANGELOG.rst

@@ -10,6 +10,8 @@ Unreleased
 
 .. vendor-insert-here
 
+- Add GitHub issue form schema and pre-commit hook (:issue:`588`).
+
 0.33.3
 ------
 

docs/precommit_usage.rst

@@ -183,6 +183,20 @@ Validate GitHub Actions against the schema provided by SchemaStore
         - id: check-github-actions
 
 
+``check-github-issue-forms``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Validate GitHub issue forms against the schema provided by SchemaStore
+
+.. code-block:: yaml
+    :caption: example config
+
+    - repo: https://github.com/python-jsonschema/check-jsonschema
+      rev: 0.33.3
+      hooks:
+        - id: check-github-issue-forms
+
+
 ``check-github-workflows``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 

docs/usage.rst

@@ -96,6 +96,7 @@ SchemaStore and other sources:
 - ``vendor.dependabot``
 - ``vendor.drone-ci``
 - ``vendor.github-actions``
+- ``vendor.github-issue-forms``
 - ``vendor.github-workflows``
 - ``vendor.gitlab-ci``
 - ``vendor.meltano``