drone-matrix/_docs/data/data.yaml
Robert Kaussow 22ead9610a
chore: replace deprecated template-lib (#103)
BREAKING CHANGE: The new template helper provided by https://github.com/thegeeklab/drone-plugin-lib/pull/28 is using pure Golang templates and sprig functions. As the unmaintained Golang handlebar library was removed entirely, the template syntax has changed and custom templates need to be adjusted. For more details, please read the [documentation](https://drone-plugin-index.geekdocs.de/plugins/drone-matrix/#parameters).
2023-02-08 16:22:10 +01:00

41 lines
1.3 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 [pipeline struct](https://pkg.go.dev/github.com/thegeeklab/drone-plugin-lib/v2/drone#Pipeline)
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: "Build {{ .Build.Status }} [{{ .Repo.Owner }}/{{ .Repo.Name }}#{{ trunc 8 .Commit.SHA }}]({{ .Build.Link }}) ({{ .Build.Branch }}) by {{ .Commit.Author }}"
type: string
required: false