From 1919eebb41bf2fb9c9ad4d813ca2cb2c9165dbb9 Mon Sep 17 00:00:00 2001
From: Mark Sharpley <698889+markopolo123@users.noreply.github.com>
Date: Fri, 14 Oct 2022 21:34:51 +0100
Subject: [PATCH] fix(docs.md): required for woodpecker plugin acceptance
Signed-off-by: Mark Sharpley <698889+markopolo123@users.noreply.github.com>
---
docs.md | 43 +++++++++++++++++++++++++++++++++++++++++++
1 file changed, 43 insertions(+)
create mode 100644 docs.md
diff --git a/docs.md b/docs.md
new file mode 100644
index 0000000..b17bb9e
--- /dev/null
+++ b/docs.md
@@ -0,0 +1,43 @@
+---
+name: Gitea Comment
+authors: markopolo123
+description: Plugin to add comments to a Gitea Pull Request
+tags: [Gitea, comment]
+containerImage: mcs94/gitea-comment
+containerImageUrl: https://hub.docker.com/r/mcs94/gitea-comment
+url: https://github.com/markopolo123/gitea-comment-plugin
+---
+
+A Woodpecker plugin to post comments onto a Gitea Pull Request.
+
+## Usage
+
+Example pipeline:
+
+```yaml
+pipeline:
+ comment:
+ image: mcs94/gitea-comment
+ settings:
+ gitea_address: https://gitea.url.goes.here
+ gitea_token:
+ from_secret: gitea_token
+ comment: >
+ ✅ Build ${CI_BUILD_EVENT} of `${CI_REPO_NAME}` has status `${CI_BUILD_STATUS}`.
+
+ 📝 Commit by ${CI_COMMIT_AUTHOR} on `${CI_COMMIT_BRANCH}`:
+
+ `${CI_COMMIT_MESSAGE}`
+
+ 🌐 ${CI_BUILD_LINK}
+ when:
+ event: [pull_request]
+```
+
+## Settings
+
+|Name|Description|Default|
+|---|---|---|
+| `gitea_address` |URL for your gitea instance| none|
+| `gitea_token` |Gitea API token| none|
+| `comment` |comment to add to Pull Request|none|