4
4
5
5
` pre-commit-circleci ` is a
6
6
[ pre-commit] ( https://github.com/pre-commit/pre-commit ) component that checks
7
- CircleCI configuration YAML files in Git repositories. It wraps
7
+ CircleCI configuration YAML files in Git repositories. It wraps
8
8
[ circleci-cli] ( https://github.com/CircleCI-Public/circleci-cli ) in a hook that
9
9
pre-commit can use.
10
10
11
-
12
11
## Requirements
13
12
14
13
` pre-commit-circleci ` requires the following to run:
15
14
16
- * [ pre-commit] ( http://pre-commit.com )
17
- * [ circleci-cli] ( https://github.com/CircleCI-Public/circleci-cli )
18
-
15
+ - [ pre-commit] ( http://pre-commit.com )
16
+ - [ circleci-cli] ( https://github.com/CircleCI-Public/circleci-cli )
19
17
20
18
## Installation
21
19
22
20
1 . [ Install pre-commit] ( https://pre-commit.com/#install ) .
23
21
1 . [ Install circlei-cli] ( https://github.com/CircleCI-Public/circleci-cli ) .
24
- 1 . Create a ` .pre-commit-config.yaml ` file in your repository. Set up CircleCI
22
+ 1 . Create a ` .pre-commit-config.yaml ` file in your repository. Set up CircleCI
25
23
validation as follows:
26
24
``` yaml
27
25
repos :
28
- - repo : http ://github.com/KoBoldMetals/pre-commit-circleci
26
+ - repo : https ://github.com/KoBoldMetals/pre-commit-circleci
29
27
rev : v0.0.4
30
28
hooks :
31
- - id : circleci-validate
29
+ - id : circleci-validate
32
30
` ` `
33
31
1. Run ` pre-commit install` to install the hook.
34
32
35
-
36
33
# # Contributing
37
34
38
35
To contribute to `pre-commit-circleci`, clone this repository locally and
39
36
commit your code on a separate branch, then submit a pull request.
40
37
41
-
42
38
# # Authors
43
39
44
40
- GitHub [@mplough](https://github.com/mplough)
@@ -48,7 +44,6 @@ commit your code on a separate branch, then submit a pull request.
48
44
shell-lint](https://github.com/detailyang/pre-commit-shell) was used as a
49
45
template for the validation hook.
50
46
51
-
52
47
# # License
53
48
54
49
pre-commit-circleci is licensed under the [MIT](https://github.com/KoBoldMetals/pre-commit-circleci/blob/master/LICENSE) license.
0 commit comments