tboudreaux/SERiF
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

ci(post-commit): updated to track post-commit

Browse Source
This commit is contained in:
Emily Boudreaux
2025-03-17 13:31:54 -04:00
parent 4d12b6beb2
commit 7568eb1a46
3 changed files with 64 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
commit-config/hooks/READEME.md
View File

@@ -4,12 +4,18 @@ All 4DSSE files should have a header specifying authors, last edits, copyright,
Hook should be setup automatically to run on each commit.
## Dependencies
- GitPython
- Python (>=3.10)
## Usage
This script assumes that an enviromental variable has been set which points to the root of the 4DSSE project. This is used to retreive the git log so that author information and last update date information may be read. By default this uses the enviromental variable `_4DSSE_ROOT`; however, this may be changed with the `--root` command line flag. Whatever is set as `--root` will be the name of the enviromental variable this script will search for.
## Installation
Generally one is intended to use this by copying `post-commit` into the `.git/hooks` directory. This can be done simply by running the install script (note that the `_4DSEE_ROOT` enviromental variable **must** be set.)
```bash
install.sh
```
## Manual Usage
The python script `formatHeader.py` assumes that an enviromental variable has been set which points to the root of the 4DSSE project. This is used to retreive the git log so that author information and last update date information may be read. By default this uses the enviromental variable `_4DSSE_ROOT`; however, this may be changed with the `--root` command line flag. Whatever is set as `--root` will be the name of the enviromental variable this script will search for.
General usage might look like
```bash