DEPRECATION NOTICE and call for further development

This repo is no longer being maintained since I no longer use Circle-CI.

The upstream project that pre-commit hook relies on has also been deprecated and replaced with https://github.com/CircleCI-Public/circleci-cli.

If you use Circle-CI and find this project useful, please consider forking this project and making it work with the new circleci-cli. If you do so, open a ticket here and I will link to your project.

pre-commit-circleci

pre-commit-circleci is a pre-commit component, which wraps circleci to check CircleCI config yaml files.

Table of Contents

• Requirements
• Install
• Contributing
• License
• Author

Requirements

pre-commit-circleci requires the following to run:

• pre-commit
• circleci local-cli
• docker is a prerequisite for circleci local-cli

Install

1. create .pre-commit-config.yaml in you git project
2. pre-commit install
3. enjoy it

example .pre-commit-config.yaml as following:

-   repo: http://github.com/danielhoherd/pre-commit-circleci
    rev: v0.0.1
    hooks:
    - id: circleci-validate

Contributing

To contribute to pre-commit-circleci, clone this repo locally and commit your code on a separate branch.

Author

• GitHub @danielhoherd
• GitHub @detailyang - pre-commit shell-lint was used as a template for pre-commit circleci-validate.

License

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