0
0
mirror of https://github.com/thegeeklab/wp-matrix.git synced 2024-11-28 08:50:35 +00:00
wp-matrix/_docs/data/data.yaml
2023-08-16 10:59:02 +02:00

44 lines
1.4 KiB
YAML

---
properties:
- name: username
description: Authentication username. If set, the `password` parameter is required as well.
type: string
required: false
- name: password
description: Authentication password.
type: string
required: false
- name: user_id
description: Aauthentication User ID. If set, the `access_token` parameter is required as well.
type: string
required: false
- name: access_token
description: Authentication access token.
type: string
required: false
- name: homeserver
description: The Matrix homeserver url to use.
defaultValue: https://matrix.org
type: string
required: false
- name: roomid
description: Room ID to send messages to.
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.Slug }}]({{ .Pipeline.URL }}){{ if .Curr.Branch }} ({{ .Curr.Branch }}){{ end }} by {{ .Curr.Author.Name }}<br/>
Message: {{ .Curr.Message }}{{ if .Curr.URL }} ([source]({{ .Curr.URL }})){{ end }}
type: string
required: false