listens for git webhooks and runs bash scripts when they arrive
Go to file
AJ ONeal f4cda06e64 refactor webhooks 2020-09-28 21:18:04 -06:00
assets git-deploy static server with basic options 2020-09-28 01:26:16 -06:00
html work 2020-09-26 15:45:20 -04:00
internal refactor webhooks 2020-09-28 21:18:04 -06:00
public git-deploy static server with basic options 2020-09-28 01:26:16 -06:00
tools git-deploy static server with basic options 2020-09-28 01:26:16 -06:00
vendor vendor deps 2020-09-28 21:17:23 -06:00
.gitignore handle .env files 2020-09-28 03:56:51 -06:00
.gitmodules work 2020-09-19 13:59:59 -04:00
.prettierignore work 2020-09-19 13:59:59 -04:00
.prettierrc git-deploy static server with basic options 2020-09-28 01:26:16 -06:00
AUTHORS add LICENSE and AUTHORS 2020-09-28 21:17:10 -06:00
LICENSE add LICENSE and AUTHORS 2020-09-28 21:17:10 -06:00
README.md refactor webhooks 2020-09-28 21:18:04 -06:00
github.go refactor webhooks 2020-09-28 21:18:04 -06:00
go.mod handle github and github-like hooks 2020-09-28 21:17:23 -06:00
go.sum handle github and github-like hooks 2020-09-28 21:17:23 -06:00
main.go refactor webhooks 2020-09-28 21:18:04 -06:00

README.md

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

Add Webhooks

To add a webhook you'll first need a secret

with node.js:

crypto.randomBytes(16).toString("hex");

Then you'll need to set up the webhook in your platform of choice.

Github

New Webhook: https://github.com/YOUR_ORG/YOUR_REPO/settings/hooks/new

Payload URL: https://YOUR_DOMAIN/api/webhooks/github
Content-Type: application/json
Secret: YOUR_SECRET
Which events would you like to trigger this webhook?
Just the `push` event.
Active: ✅

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.

How to Generate a Base64 Secret

in your browser:

(async function () {
  var rnd = new Uint8Array(16);
  await crypto.getRandomValues(rnd);
  var b64 = [].slice
    .apply(rnd)
    .map(function (ch) {
      return String.fromCharCode(ch);
    })
    .join("");
  var secret = btoa(b64)
    .replace(/\//g, "_")
    .replace(/\+/g, "-")
    .replace(/=/g, "");
  console.info(secret);
})();

with node.js:

crypto
  .randomBytes(16)
  .toString("base64")
  .replace(/\+/g, "-")
  .replace(/\//g, "_")
  .replace(/=/g, "");

License

Copyright 2020. All rights reserved.