Skip to content

updated README.md with installation section #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

updated README.md with installation section #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,19 @@ Current supported pre-receive (server side) checks
* Erb template syntax
* Puppet-lint
* Yaml (hiera data) syntax

Installation
============

Clone this repository

git clone https://github.com/pixelated-project/puppet-git-hooks.git

Go in the git hooks directory of you puppet git repository

cd <PATH_TO_YOUR_PUPPET_REPO>/.git/hooks

Create symlinks to the `pre-commit` file and the `commit_hooks` directory

ln -s <PATH_TO_PUPPET-GIT-HOOKS_REPO>/pre-commit
ln -s <PATH_TO_PUPPET-GIT-HOOKS_REPO>/commit_hooks
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like it would better to use the provided deploy-git-hook script.

<PATH_TO_PUPPET-GIT_HOOKS_REPO>/deploy-git-hook -d <PATH_TO_YOUR_PUPPET_REPO> -r