0
0
mirror of https://github.com/thegeeklab/wp-github-comment.git synced 2024-11-22 00:00:42 +00:00

cleanup docs and examples

This commit is contained in:
Robert Kaussow 2024-03-12 20:43:36 +01:00
parent 568738a12a
commit abc57db69a
Signed by: xoxys
GPG Key ID: 4E692A2EAECC03C0

View File

@ -29,14 +29,11 @@ Only pull request events are supported by this plugin. Running the plugin on oth
{{< /hint >}} {{< /hint >}}
```YAML ```YAML
kind: pipeline
name: default
steps: steps:
- name: pr-comment - name: pr-comment
image: quay.io/thegeeklab/wp-github-comment image: quay.io/thegeeklab/wp-github-comment
settings: settings:
api_key: ghp_3LbMg9Kncpdkhjp3bh3dMnKNXLjVMTsXk4sM api_key: ghp_randomstring
message: "CI run completed successfully" message: "CI run completed successfully"
update: true update: true
``` ```
@ -71,7 +68,7 @@ docker run --rm \
-e CI_REPO_OWNER=octocat \ -e CI_REPO_OWNER=octocat \
-e CI_REPO_NAME=foo \ -e CI_REPO_NAME=foo \
-e CI_COMMIT_PULL_REQUEST=1 -e CI_COMMIT_PULL_REQUEST=1
-e PLUGIN_API_KEY=abc123 \ -e PLUGIN_API_KEY=ghp_randomstring \
-e PLUGIN_MESSAGE="Demo comment" \ -e PLUGIN_MESSAGE="Demo comment" \
-v $(pwd):/build:z \ -v $(pwd):/build:z \
-w /build \ -w /build \