Merge pull request #616 from edgarrmondragon/citation.cff

Add `CITATION.cff` schema and pre-commit hook

Author: sirosen

.pre-commit-hooks.yaml

@@ -78,6 +78,16 @@
   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`
+- id: check-citation-file-format
+  name: Validate Citation File Format
+  description: 'Validate Citation File Format'
+  entry: check-jsonschema --builtin-schema vendor.citation-file-format
+  language: python
+  files: ^CITATION.cff$
+
 # 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

@@ -8,6 +8,8 @@ CHANGELOG
 Unreleased
 ----------
 
+- Add Citation File Format schema and pre-commit hook. Thanks :user:`edgarrmondragon`! (:issue:`502`)
+
 .. vendor-insert-here
 
 - Update vendored schemas: circle-ci, compose-spec, dependabot, meltano, mergify,

docs/precommit_usage.rst

@@ -113,6 +113,20 @@ Validate CircleCI config against the schema provided by SchemaStore
         - id: check-circle-ci
 
 
+``check-citation-file-format``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Validate Citation File Format
+
+.. code-block:: yaml
+    :caption: example config
+
+    - repo: https://github.com/python-jsonschema/check-jsonschema
+      rev: 0.34.1
+      hooks:
+        - id: check-citation-file-format
+
+
 ``check-cloudbuild``
 ~~~~~~~~~~~~~~~~~~~~
 

docs/usage.rst

@@ -91,6 +91,7 @@ SchemaStore and other sources:
 - ``vendor.bitbucket-pipelines``
 - ``vendor.buildkite``
 - ``vendor.circle-ci``
+- ``vendor.citation-file-format``
 - ``vendor.cloudbuild``
 - ``vendor.codecov``
 - ``vendor.compose-spec``