gitdeploy/README.md

1.3 KiB

git-deploy

git-deploy is an app for handling continuous deployment of static websites.

Build

pushd html/
npm install
./scripts/development
popd
go mod tidy
go mod vendor
go generate -mod=vendor ./...
go build -mod=vendor .
./git-deploy run --listen :3000 --serve-path ./overrides

TODO

git-deploy is intended for use with static websites that are generated after changes are pushed to a Git repository. This works with sites that are being edited in code and tracked in Git. Sites that have their content managed with a headless CMS that pushes to Git are also very well-suited.

git-deploy supports verified webhooks from Github, Bitbucket, and Gitea.

git-deploy is written in Go. This means that it's a standalone binary available on all major operating systems and architectures. It provides an API with endpoints that handle webhooks, allow for initiation of builds, and getting the status of builds and build jobs.

git-deploy comes with a simple interface. The interface be disabled if you don't want to use it.

git-deploy also comes with basic authentication via integration with Pocket ID. Authentication can also be disabled if you don't want to use it. The built-in interface requires the built-in authentication.