0
0
mirror of https://github.com/thegeeklab/wp-matrix.git synced 2024-06-02 18:39:40 +02:00
wp-matrix/_docs/data/data.yaml

44 lines
1.4 KiB
YAML
Raw Normal View History

2022-05-28 15:24:23 +02:00
---
properties:
- name: username
2022-05-29 22:22:48 +02:00
description: Authentication username. If set, the `password` parameter is required as well.
2022-05-28 15:24:23 +02:00
type: string
required: false
- name: password
2022-05-29 22:22:48 +02:00
description: Authentication password.
2022-05-28 15:24:23 +02:00
type: string
required: false
- name: user_id
2022-05-29 22:22:48 +02:00
description: Aauthentication User ID. If set, the `access_token` parameter is required as well.
2022-05-28 15:24:23 +02:00
type: string
required: false
- name: access_token
2022-05-29 22:22:48 +02:00
description: Authentication access token.
2022-05-28 15:24:23 +02:00
type: string
required: false
- name: homeserver
2022-05-28 15:24:23 +02:00
description: The Matrix homeserver url to use.
defaultValue: https://matrix.org
type: string
required: false
- name: roomid
2022-05-29 22:22:48 +02:00
description: Room ID to send messages to.
2022-05-28 15:24:23 +02:00
type: string
required: false
- name: template
description: |
Golang template for the message. The [Metadata struct](https://pkg.go.dev/github.com/thegeeklab/wp-plugin-go/plugin#Metadata)
is exposed to the template and all fields can be referenced. To extend the functionality, [sprig functions](https://masterminds.github.io/sprig/) can also be used.
defaultValue: |
Status: **{{ .Pipeline.Status }}**<br/>
Build: [{{ .Repository.Owner }}/{{ .Repository.Name }}]({{ .Repository.Link }}){{ if .Repository.Branch }} ({{ .Repository.Branch }}){{ end }} by {{ .Commit.Author }}<br/>
Message: {{ .Commit.Message }}
2022-05-28 15:24:23 +02:00
type: string
required: false