From 3c5f68f348ccacc1b686df35ff8188173bda0068 Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Wed, 7 Aug 2024 20:38:54 +0200 Subject: [PATCH] chore: rename roomid to room_id to harmonize parameters (#142) --- .woodpecker/notify.yml | 4 ++-- docs/content/_index.md | 4 ++-- docs/data/data.yaml | 4 ++-- plugin/plugin.go | 6 +++--- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.woodpecker/notify.yml b/.woodpecker/notify.yml index 9957125..068e30e 100644 --- a/.woodpecker/notify.yml +++ b/.woodpecker/notify.yml @@ -15,8 +15,8 @@ steps: from_secret: matrix_homeserver password: from_secret: matrix_password - roomid: - from_secret: matrix_roomid + room_id: + from_secret: matrix_room_id username: from_secret: matrix_username when: diff --git a/docs/content/_index.md b/docs/content/_index.md index 2a65db0..a0426e2 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -26,7 +26,7 @@ steps: image: quay.io/thegeeklab/matrix settings: homeserver: https://matrix.org - roomid: randomstring:matrix.org + room_id: randomstring:matrix.org username: octocat password: random-secret ``` @@ -57,7 +57,7 @@ docker build --file Containerfile.multiarch --tag thegeeklab/wp-matrix . ```Shell docker run --rm \ - -e PLUGIN_ROOMID=randomstring:matrix.org \ + -e PLUGIN_ROOM_ID=randomstring:matrix.org \ -e PLUGIN_USERNAME=octocat \ -e PLUGIN_PASSWORD=random-secret \ -v $(pwd):/build:z \ diff --git a/docs/data/data.yaml b/docs/data/data.yaml index 028e36a..f29ff71 100644 --- a/docs/data/data.yaml +++ b/docs/data/data.yaml @@ -33,9 +33,9 @@ properties: type: string required: false - - name: roomid + - name: room_id description: | - Roomid to send messages to. + Room ID to send messages to. type: string required: false diff --git a/plugin/plugin.go b/plugin/plugin.go index 8367dbe..70113c4 100644 --- a/plugin/plugin.go +++ b/plugin/plugin.go @@ -110,9 +110,9 @@ func Flags(settings *Settings, category string) []cli.Flag { Category: category, }, &cli.StringFlag{ - Name: "roomid", - EnvVars: []string{"PLUGIN_ROOMID", "MATRIX_ROOMID"}, - Usage: "roomid to send messages to", + Name: "room_id", + EnvVars: []string{"PLUGIN_ROOM_ID", "PLUGIN_ROOMID", "MATRIX_ROOMID", "MATRIX_ROOM_ID"}, + Usage: "room id to send messages to", Destination: &settings.RoomID, Category: category, },