mirror of
https://github.com/thegeeklab/wp-github-comment.git
synced 2024-11-12 16:40:40 +00:00
80 lines
2.8 KiB
Markdown
80 lines
2.8 KiB
Markdown
---
|
|
title: wp-github-comment
|
|
---
|
|
|
|
[](https://ci.thegeeklab.de/repos/thegeeklab/wp-github-comment)
|
|
[](https://hub.docker.com/r/thegeeklab/wp-github-comment)
|
|
[](https://quay.io/repository/thegeeklab/wp-github-comment)
|
|
[](https://goreportcard.com/report/github.com/thegeeklab/wp-github-comment)
|
|
[](https://github.com/thegeeklab/wp-github-comment/graphs/contributors)
|
|
[](https://github.com/thegeeklab/wp-github-comment)
|
|
[](https://github.com/thegeeklab/wp-github-comment/blob/main/LICENSE)
|
|
|
|
Woodpecker CI plugin to add comments to GitHub Issues and Pull Requests.
|
|
|
|
<!-- prettier-ignore-start -->
|
|
<!-- spellchecker-disable -->
|
|
{{< toc >}}
|
|
<!-- spellchecker-enable -->
|
|
<!-- prettier-ignore-end -->
|
|
|
|
## Usage
|
|
|
|
{{< hint type=important >}}
|
|
Due to the nature of this plugin, a secret for the GitHub token may need to be exposed for pull request events in Woodpecker. Please be careful with this option, as a malicious actor may submit a pull request that exposes your secrets. Do not disclose secrets to pull requests in public environments without further protection.
|
|
{{< /hint >}}
|
|
|
|
{{< hint type=note >}}
|
|
Only pull request events are supported by this plugin. Running the plugin on other events will result in an error.
|
|
{{< /hint >}}
|
|
|
|
```YAML
|
|
kind: pipeline
|
|
name: default
|
|
|
|
steps:
|
|
- name: pr-comment
|
|
image: quay.io/thegeeklab/wp-github-comment
|
|
settings:
|
|
api_key: ghp_3LbMg9Kncpdkhjp3bh3dMnKNXLjVMTsXk4sM
|
|
message: "CI run completed successfully"
|
|
update: true
|
|
```
|
|
|
|
### Parameters
|
|
|
|
<!-- prettier-ignore-start -->
|
|
<!-- spellchecker-disable -->
|
|
{{< propertylist name=wp-github-comment.data sort=name >}}
|
|
<!-- spellchecker-enable -->
|
|
<!-- prettier-ignore-end -->
|
|
|
|
## Build
|
|
|
|
Build the binary with the following command:
|
|
|
|
```shell
|
|
make build
|
|
```
|
|
|
|
Build the container image with the following command:
|
|
|
|
```shell
|
|
docker build --file Containerfile.multiarch --tag thegeeklab/wp-github-comment .
|
|
```
|
|
|
|
## Test
|
|
|
|
```Shell
|
|
docker run --rm \
|
|
-e CI_PIPELINE_EVENT=pull_request \
|
|
-e CI_REPO_OWNER=octocat \
|
|
-e CI_REPO_NAME=foo \
|
|
-e CI_COMMIT_PULL_REQUEST=1
|
|
-e PLUGIN_API_KEY=abc123 \
|
|
-e PLUGIN_MESSAGE="Demo comment" \
|
|
-v $(pwd):/build:z \
|
|
-w /build \
|
|
thegeeklab/wp-github-comment
|
|
```
|