drone-github-comment/_docs/_index.md

title
drone-github-comment

Drone plugin to add comments to GitHub Issues and Pull Requests.

{{< toc >}}

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/drone-github-comment

Build the Docker image with the following command:

docker build --file docker/Dockerfile.amd64 --tag thegeeklab/drone-github-comment .

Usage

docker run --rm \
  -e DRONE_BUILD_EVENT=pull_request \
  -e DRONE_REPO_OWNER=octocat \
  -e DRONE_REPO_NAME=foo \
  -e DRONE_PULL_REQUEST=1
  -e PLUGIN_API_KEY=abc123 \
  -e PLUGIN_MESSAGE="Demo comment" \
  -v $(pwd):$(pwd) \
  -w $(pwd) \
  thegeeklab/drone-github-comment

Parameters

api_key

sets api key to access github api

base_url

sets api url; need to be changed for gh enterprise (default https://api.github.com)

key

sets unique key to assign to comment

message

sets file or string with comment message

update

enables update of an existing comment that matches the key

skip_missing

skips comment creation if the given message file does not exist (default false)