From 3624631433eff06e9f4854013ff5c1d7e9ab4b68 Mon Sep 17 00:00:00 2001 From: Nicolai Ort Date: Wed, 10 May 2023 20:13:56 +0200 Subject: [PATCH] Updated readme settings doc and examples --- README.md | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b57bd56..4e874c6 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,12 @@ Fun changlog and release generator. Uses changelogen for changelog generation, is able to create gitea releases and publish the changelog via matrix ## Settings 🛠️ -* `TODO:`: v +* `GITEA_DOMAIN`: Domain name of your gitea server - if not set release creation get's skipped +* `GITEA_APIKEY`: Api token for a gitea user that has the privileges to create releases in your repo +* `MATRIX_SERVER`: The matrix server's domain name - if not set notification sending get's skipped +* `MATRIX_USER`: The matrix user's username +* `MATRIX_PASSWORD`: The matrix user's password +* `MATRIX_ROOM`: The id of the notification matrix room (including the `!`) ## Examples @@ -19,8 +24,17 @@ kind: pipeline name: default steps: -- name: publish - image: registry.odit.services/library/drone-changelogger - settings: - TODO: +steps: + - name: release + image: registry.odit.services/library/drone-changelogger + pull: always + settings: + GITEA_DOMAIN: git.odit.services + GITEA_APIKEY: + from_secret: gitea_token + MATRIX_SERVER: matrix.org + MATRIX_USER: "oditservicesbot" + MATRIX_PASSWORD: + from_secret: matrix_password + MATRIX_ROOM: "!qwertzuiopasdfghjk:matrix.org" ``` \ No newline at end of file