/drone-gh-pages

Drone plugin for publishing to GitHub Pages

Primary LanguageGoApache License 2.0Apache-2.0

drone-gh-pages

Build Status Join the discussion at https://discourse.drone.io Drone questions at https://stackoverflow.com Go Doc Go Report

Drone plugin for publishing static website to GitHub Pages. For the usage information and a listing of the available options please take a look at the docs.

Build

Build the binary with the following commands:

go build

Docker

Build the Docker image with the following commands:

GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -a -tags netgo -o release/linux/amd64/drone-gh-pages
docker build --rm -t plugins/gh-pages .

Usage

docker run --rm \
  -e PLUGIN_USERNAME="octocat" \
  -e PLUGIN_PASSWORD="p455w0rd" \
  -e PLUGIN_PAGES_DIRECTORY="docs" \
  -e DRONE_COMMIT_AUTHOR="Drone" \
  -e DRONE_COMMIT_AUTHOR_EMAIL="drone@example.com" \
  -e DRONE_REMOTE_URL="https://github.com/drone-plugins/drone-docker.git" \
  -e DRONE_WORKSPACE="$(pwd)" \
  -v $(pwd):$(pwd) \
  -w $(pwd) \
  plugins/gh-pages