You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-11Lines changed: 30 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,9 @@
1
-
Looking for additional maintners. I do not use puppet on a daily basis anymore, so I'd appreciate an extra
2
-
help ensuring this project meets the needs of the people using it. Please contact me through github if you
3
-
are interested in helping maintain this project. Thank you!
4
-
5
1
puppet-git-hooks
6
2
================
7
3
8
-
Git hooks to assist puppet module development. Client side hooks allow for various checks before commits are staged. Server side hooks are provided for infrastructural reinforcement of various standardization compliances.
4
+
Git hooks to assist puppet module development. Client side hooks allow for
5
+
various checks before commits are staged. Server side hooks are provided
6
+
for infrastructural reinforcement of various standardization compliances.
9
7
10
8
Current supported pre-commit (client side) checks
11
9
=================================================
@@ -31,7 +29,10 @@ Current supported pre-receive (server side) checks
31
29
Installing dependencies
32
30
=======================
33
31
34
-
You can install all required dependencies with bundler. List of dependencies you will find in `Gemfile`. By default it installs puppet in version 3.8.6, if you wish, change it to one, which you use. To install run bundler inside your checkout:
32
+
You can install all required dependencies with bundler. List of dependencies
33
+
you will find in `Gemfile`. By default it installs puppet in version 3.8.6,
34
+
if you wish, change it to one, which you use. To install run bundler inside
35
+
your checkout:
35
36
36
37
```bash
37
38
bundle install
@@ -40,13 +41,16 @@ bundle install
40
41
Usage
41
42
=====
42
43
43
-
In your git repository you can symlink the pre-commit file from this repository to the .git/hooks/pre-commit of your repository you want to implement this feature.
44
+
In your git repository you can symlink the pre-commit file from this
45
+
repository to the .git/hooks/pre-commit of your repository you want to
If you are using git submodules this can be achieved by getting the gitdir from the .git file in your submodule and symlinking to that gitdir location/
52
+
If you are using git submodules this can be achieved by getting the gitdir
53
+
from the .git file in your submodule and symlinking to that gitdir location/
50
54
51
55
```bash
52
56
$ cat .git
@@ -84,12 +88,13 @@ deploy-git-hook
84
88
85
89
In a wrapper
86
90
===============
87
-
You can call from your own custom pre-commit. This allows you to combine these with your own checks
91
+
You can call from your own custom pre-commit. This allows you to combine
92
+
these with your own checks.
88
93
89
94
For example, if you've cloned this repo to ~/.puppet-git-hooks
90
95
91
96
92
-
The .git/hooks/pre-commit with your puppet code might look like this
97
+
The .git/hooks/pre-commit with your puppet code might look like this:
93
98
94
99
```bash
95
100
#!/bin/bash
@@ -102,7 +107,10 @@ if [ -e ~/.puppet-git-hooks/pre-commit ]; then
102
107
fi
103
108
```
104
109
105
-
Additionally you can call pre-commit script with two options `-s` and `-a`. First one silence standard informations, which file is currently being checked. Second one allow you to check whole repo, not only files changed locally.
110
+
Additionally you can call pre-commit script with two options `-s` and `-a`.
111
+
First one silence standard informations, which file is currently being
112
+
checked. Second one allow you to check whole repo, not only files changed
113
+
locally.
106
114
107
115
Configuration
108
116
===============
@@ -117,3 +125,14 @@ Current options:
117
125
* PUPPET_LINT_OPTIONS
118
126
* PUPPET_LINT_FAIL_ON_WARNINGS
119
127
* UNSET_RUBY_ENV (for GitLab users)
128
+
129
+
Maintainers
130
+
===========
131
+
132
+
*[David Wahlstrom](https://github.com/drwahl)
133
+
*[Paweł Szczepaniak](https://github.com/krzyzakp)
134
+
135
+
We are still looking for additional maintainers. Please contact me via
0 commit comments