danielhoherd / pre-commit-circleci

pre-commit hook for circleci config validation.

pre-commit-circleci

pre-commit-circleci is a pre-commit component that checks CircleCI configuration YAML files in Git repositories. It wraps circleci-cli in a hook that pre-commit can use.

Requirements

pre-commit-circleci requires the following to run:

• pre-commit
• circleci-cli

Installation

1. Install pre-commit.
2. Install circlei-cli.
3. Create a .pre-commit-config.yaml file in your repository. Set up CircleCI validation as follows:

   repos:
     - repo: https://github.com/KoBoldMetals/pre-commit-circleci
       rev: v0.0.4
       hooks:
         - id: circleci-validate

4. Run pre-commit install to install the hook.

Contributing

To contribute to pre-commit-circleci, clone this repository locally and commit your code on a separate branch, then submit a pull request.

Authors

• GitHub @mplough
• GitHub @danielhoherd - forked from his original pre-commit-circle-ci tool.
• GitHub @detailyang - pre-commit shell-lint was used as a template for the validation hook.

License

pre-commit-circleci is licensed under the MIT license.