mirror of
https://github.com/empayre/fleet.git
synced 2024-11-06 08:55:24 +00:00
65 lines
1.6 KiB
Markdown
65 lines
1.6 KiB
Markdown
# Git Hooks
|
|
|
|
This document aims to guide you through the benefits and utilities of implementing Git Hooks in your
|
|
development workflow
|
|
|
|
## Introduction
|
|
|
|
Git hooks are scripts that Git executes before or after events such as `commit` or `push`. This
|
|
document discusses the benefits of using a `push` hook for Fleet Developers.
|
|
|
|
## Benefits
|
|
|
|
### Reduced Waiting Time
|
|
|
|
Imagine pushing a commit and then realizing that there was a minor issue (ie. `make
|
|
lint-go`), forcing you to restart the entire CI process, including tests that can take up to
|
|
~30 minutes to
|
|
complete
|
|
|
|
### Streamlined Workflow
|
|
|
|
Reduce the feedback loop and aid rapid development
|
|
|
|
### Saving CI Resources
|
|
|
|
By reducing the number of failed builds, you free up CI resources for other tasks
|
|
|
|
## Getting Started
|
|
|
|
1. Copy the `pre-push` to your fleet repo hooks directory
|
|
|
|
```bash
|
|
cp ./git-hooks/backend/setup/pre-push ./.git/hooks/
|
|
chmod +x ./.git/hooks/pre-push
|
|
```
|
|
|
|
2. Edit the `pre-push` file and specify the scripts you want to run. Filenames must match scripts in the
|
|
`./git-hooks/backend/hooks/` directory. This also specifies the order they run.
|
|
|
|
```bash
|
|
declare -a USED_HOOKS=(
|
|
"compile-go"
|
|
"db-schema"
|
|
"lint-go"
|
|
)
|
|
```
|
|
|
|
## Contributing
|
|
|
|
All related code is located in the `./git-hooks` directory
|
|
|
|
Scripts in the `hooks/` directory need to exit a non-zero code in order to fail properly. These
|
|
scripts do not need to be executable because we are calling it from the `pre-push` script as `bash
|
|
$SCRIPT_NAME`
|
|
|
|
Make sure you promote your changes in Slack!
|
|
|
|
|
|
## Contributing Ideas
|
|
|
|
- Update/Add a script to the `hooks` directory
|
|
- Build out `./git-hooks/frontend/`
|
|
- ??????
|
|
|