diff --git a/README.md b/README.md index 82fede5..5a159f9 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,19 @@ -# gitea-comment-plugin +# gitea-pull-request-comment-plugin -A Woodpecker plugin to post comments onto a Gitea Pull Request. +A Woodpecker plugin to post comments onto a Gitea Pull Requests. Note this currently only works on `pull request` events. +You'll need to generate a [Gitea API token](https://docs.gitea.io/en-us/api-usage/) before +you can use this. + ## Usage/Examples +This example uses a woodpecker secret to pass the gitea API token to the pipeline +job. The secret is enabled for use on `pull requests` . + + + ```yaml pipeline: comment: @@ -41,7 +49,7 @@ docker run \ -e PLUGIN_COMMENT="test comment" \ -e PLUGIN_GITEA_TOKEN="tokenhere" \ -e PLUGIN_GITEA_ADDRESS="https://gitea.url.here" \ --e CI_REPO_OWNER="repoowwer" \ +-e CI_REPO_OWNER="repoowner" \ -e CI_REPO_NAME="yourrepo" \ -e CI_COMMIT_PULL_REQUEST=8 \ test-gitea diff --git a/docs.md b/docs.md new file mode 100644 index 0000000..46a580a --- /dev/null +++ b/docs.md @@ -0,0 +1,43 @@ +--- +name: Gitea Comment +author: 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| diff --git a/img/comments.png b/img/comments.png index d0e210e..6fcacb4 100644 Binary files a/img/comments.png and b/img/comments.png differ diff --git a/img/secret.png b/img/secret.png new file mode 100644 index 0000000..02f04ea Binary files /dev/null and b/img/secret.png differ