Add documentation for pre-commit
This commit is contained in:
committed by
Adrien Vergé
parent
1c0dd48ccd
commit
c8e516be2f
@@ -26,3 +26,4 @@ Table of contents
|
|||||||
disable_with_comments
|
disable_with_comments
|
||||||
development
|
development
|
||||||
text_editors
|
text_editors
|
||||||
|
integration
|
||||||
|
|||||||
16
docs/integration.rst
Normal file
16
docs/integration.rst
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
Integration with other software
|
||||||
|
===============================
|
||||||
|
|
||||||
|
Integration with pre-commit
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
You can integrate yamllint in `pre-commit <http://pre-commit.com/>`_ tool.
|
||||||
|
Here is an example, to add in your .pre-commit-config.yaml
|
||||||
|
|
||||||
|
.. code:: yaml
|
||||||
|
|
||||||
|
# Update the sha variable with the release version that you want, from the yamllint repo
|
||||||
|
- repo: https://github.com/adrienverge/yamllint.git
|
||||||
|
sha: v1.8.1
|
||||||
|
hooks:
|
||||||
|
- id: yamllint
|
||||||
Reference in New Issue
Block a user