summaryrefslogtreecommitdiffstats
path: root/hack/hooks/verify_generated_modules/README.md
blob: 093fcf76a318ebdbc459794e32e4bf2484a39b7c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# Verify Generated Modules

Pre-commit hook for verifying that generated library modules match
their EXPECTED content. Library modules are generated from fragments
under the `roles/lib_(openshift|utils)/src/` directories.

If the attempted commit modified files under the
`roles/lib_(openshift|utils)/` directories this script will run the
`generate.py --verify` command.

This script will **NOT RUN** if module source fragments are modified
but *not part of the commit*. I.e., you can still make commits if you
modified module fragments AND other files but are *not comitting the
the module fragments*.

# Setup Instructions

Standard installation procedure. Copy the hook to the `.git/hooks/`
directory and ensure it is executable.