Skip to content
Drone plugin for publishing to GitHub Pages
Go Jsonnet
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

drone-gh-pages

Build Status Gitter chat 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 command:

export GOOS=linux
export GOARCH=amd64
export CGO_ENABLED=0
export GO111MODULE=on

go build -v -a -tags netgo -o release/linux/amd64/drone-gh-pages

Docker

Build the Docker image with the following command:

docker build \
  --label org.label-schema.build-date=$(date -u +"%Y-%m-%dT%H:%M:%SZ") \
  --label org.label-schema.vcs-ref=$(git rev-parse --short HEAD) \
  --file docker/Dockerfile.linux.amd64 --tag plugins/gh-pages .

Usage

PLUGIN_NETRC_MACHINE is optional, default value is "github.com".

docker run --rm \
  -e PLUGIN_USERNAME="octocat" \
  -e PLUGIN_PASSWORD="p455w0rd" \
  -e PLUGIN_PAGES_DIRECTORY="docs" \
  -e PLUGIN_NETRC_MACHINE="github.com" \
  -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
You can’t perform that action at this time.