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

feat: add readme

This commit is contained in:
Urko 2023-02-26 10:58:32 +01:00
parent c54366a21e
commit 70a777db3a
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md Normal file
View File

@ -0,0 +1,18 @@
# git-webhook-ci
Tool to automatize your deploy based on file write changes
## Context
As a security risk that could be allow a webhook listener on a VPS for your git repository, I've decided
to create this package which is a listener to file changes on write. This will trigger a bash script which
you shold place on your server to run desired tasks. In my case I've done this to run a bash deploy command like
- git pull
- build
- move build to desired dir
- restart services like nginx or whatever
## Installation
### Requirements
- [Go version > 1.19](https://go.dev/dl/)
- [GNU Make 4.3](https://www.gnu.org/software/make/)
- [goreportcard-cli](https://github.com/gojp/goreportcard)
- [golangci-lint](https://golangci-lint.run/)