0
0
mirror of https://github.com/thegeeklab/wp-matrix.git synced 2024-11-21 14:20:41 +00:00
wp-matrix/docs/data/data.yaml

82 lines
2.2 KiB
YAML

---
properties:
- name: access_token
description: |
Authentication access token.
type: string
required: false
- name: homeserver
description: |
Matrix home server url.
type: string
defaultValue: "https://matrix.org"
required: false
- name: insecure_skip_verify
description: |
Skip SSL verification.
type: bool
defaultValue: false
required: false
- name: log_level
description: |
Plugin log level.
type: string
defaultValue: "info"
required: false
- name: password
description: |
Authentication password.
type: string
required: false
- name: room_id
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.
type: string
defaultValue: |
Status: **{{ .Pipeline.Status }}**
Build: [{{ .Repository.Slug }}]({{ .Pipeline.URL }}){{ if .Curr.Branch }} ({{ .Curr.Branch }}){{ end }} by {{ .Curr.Author.Name }}
Message: {{ .Curr.Title }}{{ if .Curr.URL }} ([source]({{ .Curr.URL }})){{ end }}
required: false
- name: template_unsafe
description: |
Render raw HTML and potentially dangerous links in template.
By default, raw HTML and potentially dangerous links in the template are not rendered. If inline HTML is used,
it may be necessary to activate this option. In such cases, please ensure that the CI configuration files
in the git repository are protected against malicious changes.
type: bool
defaultValue: false
required: false
- name: user_id
description: |
Authentication user ID.
If set, the `access_token` parameter is required as well.
type: string
required: false
- name: username
description: |
Authentication username.
If set, the `password` parameter is required as well.
type: string
required: false