https://github.com/danielhoherd/pre-commit-circleci

pre-commit hook for circleci config validation.
https://github.com/danielhoherd/pre-commit-circleci

Last synced: 2 months ago
JSON representation

pre-commit hook for circleci config validation.

• Host: GitHub
• URL: https://github.com/danielhoherd/pre-commit-circleci
• Owner: danielhoherd
• License: mit
• Created: 2018-05-08T23:02:14.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-08-11T22:18:10.000Z (over 3 years ago)
• Last Synced: 2023-02-26T07:36:17.633Z (almost 2 years ago)
• Language: Shell
• Size: 12.7 KB
• Stars: 2
• Watchers: 2
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![GitHub License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/circleci/local-cli/master/LICENSE)

# pre-commit-circleci

`pre-commit-circleci` is a

[pre-commit](https://github.com/pre-commit/pre-commit) component that checks

CircleCI configuration YAML files in Git repositories. It wraps

[circleci-cli](https://github.com/CircleCI-Public/circleci-cli) in a hook that

pre-commit can use.

## Requirements

`pre-commit-circleci` requires the following to run:

- [pre-commit](http://pre-commit.com)

- [circleci-cli](https://github.com/CircleCI-Public/circleci-cli)

## Installation

1. [Install pre-commit](https://pre-commit.com/#install).

1. [Install circlei-cli](https://github.com/CircleCI-Public/circleci-cli).

1. Create a `.pre-commit-config.yaml` file in your repository. Set up CircleCI

   validation as follows:

   ```yaml

   repos:

     - repo: https://github.com/KoBoldMetals/pre-commit-circleci

       rev: v0.0.4

       hooks:

         - id: circleci-validate

   ```

1. 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](https://github.com/mplough)

- GitHub [@danielhoherd](https://github.com/danielhoherd) - forked from his

  original [pre-commit-circle-ci](https://github.com/danielhoherd/pre-commit-circleci) tool.

- GitHub [@detailyang](https://github.com/detailyang) - [pre-commit

  shell-lint](https://github.com/detailyang/pre-commit-shell) was used as a

  template for the validation hook.

## License

pre-commit-circleci is licensed under the [MIT](https://github.com/KoBoldMetals/pre-commit-circleci/blob/master/LICENSE) license.