docs: add readme badges and fix source code line references
Signed-off-by: Christopher Arndt <chris@chrisarndt.de>
This commit is contained in:
parent
d6e24aa359
commit
70a70531be
17
README.md
17
README.md
@ -1,7 +1,14 @@
|
||||
# drone-matrixchat-notify
|
||||
|
||||
A [drone.io] [plugin] to send notifications to Matrix chat rooms from
|
||||
CI pipeline steps.
|
||||
[](https://github.com/SpotlightKid/drone-matrixchat-notify/blob/master/LICENSE)
|
||||
[](https://github.com/SpotlightKid/drone-matrixchat-notify/tags)
|
||||
[](https://hub.docker.com/r/spotlightkid/drone-matrixchat-notify)
|
||||
[](https://github.com/SpotlightKid/drone-matrixchat-notify)
|
||||
[](https://gitlab.com/SpotlightKid/drone-matrixchat-notify)
|
||||
[](https://github.com/SpotlightKid/drone-matrixchat-notify/issues)
|
||||
|
||||
A [drone.io] [plugin] to send notifications to Matrix chat rooms from CIs
|
||||
pipeline steps. Supports *Jinja* message templates and *Markdown* rendering.
|
||||
|
||||
Example pipeline configuration:
|
||||
|
||||
@ -71,7 +78,7 @@ steps:
|
||||
placeholder substitution). The template context is controlled by the
|
||||
`pass_environment` setting, same as with non-Jinja templates, but
|
||||
placeholders use a different syntax (example: `{{DRONE_REPO}}`), so the
|
||||
`template` setting should be changed to be a valid Jinja2 template string
|
||||
`template` setting should be changed to be a valid Jinja template string
|
||||
when this is enabled.
|
||||
|
||||
Using this feature requires the `jinja2` Python module to be available
|
||||
@ -124,8 +131,8 @@ steps:
|
||||
ID of user on homeserver to send message as (ID, not username).
|
||||
|
||||
|
||||
[`DEFAULT_ALLOWED_ATTRS`]: ./matrixchat-notify.py#L27
|
||||
[`DEFAULT_ALLOWED_TAGS`]: ./matrixchat-notify.py#L34
|
||||
[`DEFAULT_ALLOWED_ATTRS`]: https://github.com/SpotlightKid/drone-matrixchat-notify/blob/master/matrixchat-notify.py#L28
|
||||
[`DEFAULT_ALLOWED_TAGS`]: https://github.com/SpotlightKid/drone-matrixchat-notify/blob/master/matrixchat-notify.py#L35
|
||||
[allowed attributes]: https://bleach.readthedocs.io/en/latest/clean.html#allowed-attributes-attributes
|
||||
[drone.io]: https://drone.io/
|
||||
[jinja]: https://jinja.palletsprojects.com/
|
||||
|
Loading…
x
Reference in New Issue
Block a user