mirror of
https://github.com/thegeeklab/drone-github-comment.git
synced 2024-11-16 08:00:39 +00:00
73 lines
2.2 KiB
Markdown
73 lines
2.2 KiB
Markdown
---
|
|
title: drone-github-comment
|
|
---
|
|
|
|
[](https://drone.thegeeklab.de/thegeeklab/drone-github-comment)
|
|
[](https://hub.docker.com/r/thegeeklab/drone-github-comment)
|
|
[](https://quay.io/repository/thegeeklab/drone-github-comment)
|
|
[](https://github.com/thegeeklab/drone-github-comment/graphs/contributors)
|
|
[](https://github.com/thegeeklab/drone-github-comment)
|
|
[](https://github.com/thegeeklab/drone-github-comment/blob/main/LICENSE)
|
|
|
|
Drone plugin to add comments to GitHub Issues and Pull Requests.
|
|
|
|
<!-- prettier-ignore-start -->
|
|
<!-- spellchecker-disable -->
|
|
{{< toc >}}
|
|
<!-- spellchecker-enable -->
|
|
<!-- prettier-ignore-end -->
|
|
|
|
## Build
|
|
|
|
Build the binary with the following command:
|
|
|
|
```Shell
|
|
export GOOS=linux
|
|
export GOARCH=amd64
|
|
export CGO_ENABLED=0
|
|
export GO111MODULE=on
|
|
|
|
make build
|
|
```
|
|
|
|
Build the Docker image with the following command:
|
|
|
|
```Shell
|
|
docker build --file docker/Dockerfile.amd64 --tag thegeeklab/drone-github-comment .
|
|
```
|
|
|
|
## Usage
|
|
|
|
```Shell
|
|
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`)
|