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

Pre-commit hooks for CircleCI validation and packing.
https://github.com/dominodatalab/pre-commit-circleci

Last synced: 29 days ago
JSON representation

Pre-commit hooks for CircleCI validation and packing.

• Host: GitHub
• URL: https://github.com/dominodatalab/pre-commit-circleci
• Owner: dominodatalab
• License: apache-2.0
• Created: 2020-11-05T17:26:13.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-08-03T21:42:31.000Z (over 2 years ago)
• Last Synced: 2023-08-07T03:05:39.038Z (over 1 year ago)
• Language: Shell
• Size: 9.77 KB
• Stars: 0
• Watchers: 8
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## pre-commit-circleci

Pre-commit hooks for CircleCI config validation and creation based around the [circleci-cli](https://github.com/CircleCI-Public/circleci-cli).

### Requirements

`pre-commit-circleci` requires:

* [circleci-cli](https://github.com/CircleCI-Public/circleci-cli#getting-started)

### Install

There are two hooks for operating on the CircleCI configuration:

* `circleci-validate` will call `circleci config validate` on the configuration and report errors.

* `circleci-pack` will call `circleci config pack` and add the resulting `.circleci/config.yaml` to the commit if files in `.circleci/template/*.yaml` have changed.

Add the following to your `.pre-commit-config.yaml`:

```yaml

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

  rev: v0.0.2

  hooks:

    - id: circleci-validate

    - id: circleci-pack

```

### Contributing

Contributions are welcome! Please feel free to create a pull request or issue and we'll make sure to take a look.