[skip ci] auto-update documentation

content/_index.md

@@ -0,0 +1,79 @@
+---
+title: wp-github-comment
+---
+
+[![Build Status](https://ci.thegeeklab.de/api/badges/thegeeklab/wp-github-comment/status.svg)](https://ci.thegeeklab.de/repos/thegeeklab/wp-github-comment)
+[![Docker Hub](https://img.shields.io/badge/dockerhub-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/thegeeklab/wp-github-comment)
+[![Quay.io](https://img.shields.io/badge/quay-latest-blue.svg?logo=docker&logoColor=white)](https://quay.io/repository/thegeeklab/wp-github-comment)
+[![Go Report Card](https://goreportcard.com/badge/github.com/thegeeklab/wp-github-comment)](https://goreportcard.com/report/github.com/thegeeklab/wp-github-comment)
+[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/wp-github-comment)](https://github.com/thegeeklab/wp-github-comment/graphs/contributors)
+[![Source: GitHub](https://img.shields.io/badge/source-github-blue.svg?logo=github&logoColor=white)](https://github.com/thegeeklab/wp-github-comment)
+[![License: MIT](https://img.shields.io/github/license/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: 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
+```

data/data.yaml

@@ -0,0 +1,34 @@
+---
+properties:
+  - name: api_key
+    description: Personal Access token to access the GitHub API.
+    type: string
+    required: true
+
+  - name: base_url
+    description: API URL. Only need to be changed for GitHub enterprise in most cases
+    defaultValue: https://api.github.com
+    type: string
+    required: false
+
+  - name: key
+    description: Unique identifier to assign to a comment. The identifier is used to update an existing comment.
+    type: string
+    required: false
+
+  - name: message
+    description: Path to file or string that contains the comment text.
+    type: string
+    required: true
+
+  - name: update
+    description: Enables update of an existing comment that matches the key.
+    defaultValue: false
+    type: bool
+    required: false
+
+  - name: skip_missing
+    description: Skips comment creation if the given message file does not exist
+    defaultValue: false
+    type: bool
+    required: false