urko
/
git-webhook-ci
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: update README

This commit is contained in:
Urko 2023-02-26 11:07:21 +01:00
parent a4ce793707
commit e02c244425
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,5 +1,7 @@
# git-webhook-ci # git-webhook-ci
Tool to automatize your deploy based on file write changes Tool to automatize your deploy based on file write changes
## Description
After some change is made in our listener file the script placed on path set on `env` variable called **WEBHOOK_SCRIPT_PATH** will be executed.
## Context ## Context
As a security risk that could be allow a webhook listener on a VPS for your git repository, I've decided As a security risk that could be allow a webhook listener on a VPS for your git repository, I've decided
@ -16,3 +18,20 @@ you shold place on your server to run desired tasks. In my case I've done this t
- [GNU Make 4.3](https://www.gnu.org/software/make/) - [GNU Make 4.3](https://www.gnu.org/software/make/)
- [goreportcard-cli](https://github.com/gojp/goreportcard) - [goreportcard-cli](https://github.com/gojp/goreportcard)
- [golangci-lint](https://golangci-lint.run/) - [golangci-lint](https://golangci-lint.run/)
### Environment Vars
As shown in .env.example you have to configure this variables in order to make your binary works right:
```.env
SCRIPT_BINARY_PATH=/bin/bash
WEBHOOK_SCRIPT_PATH=/path/to/mybashscript.sh
FILE_TO_WATCH_PATH=/path/to/myfile.txt
TEST_FILE_TO_WATCH_PATH=./test_monitor.txt
```
**TEST_FILE_TO_WATCH_PATH** is needed just to run tests
## How to use
### Build
To build you can only just `make build` command
```bash
make build
```