{"id":21689232,"url":"https://github.com/spotlightkid/drone-matrixchat-notify","last_synced_at":"2026-04-12T07:37:14.573Z","repository":{"id":183042270,"uuid":"669515264","full_name":"SpotlightKid/drone-matrixchat-notify","owner":"SpotlightKid","description":"A drone.io plugin to send notifications to Matrix chat rooms from CI pipeline steps.","archived":false,"fork":false,"pushed_at":"2023-07-24T13:44:04.000Z","size":26,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-30T00:42:20.252Z","etag":null,"topics":["ci","docker-image","drone-ci","drone-plugin","matrix-chat","matrix-nio","notification","python"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/spotlightkid/drone-matrixchat-notify","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SpotlightKid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-22T14:27:52.000Z","updated_at":"2024-01-19T14:13:30.000Z","dependencies_parsed_at":"2024-11-25T17:34:35.382Z","dependency_job_id":null,"html_url":"https://github.com/SpotlightKid/drone-matrixchat-notify","commit_stats":null,"previous_names":["spotlightkid/drone-matrixchat-notify"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/SpotlightKid/drone-matrixchat-notify","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpotlightKid%2Fdrone-matrixchat-notify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpotlightKid%2Fdrone-matrixchat-notify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpotlightKid%2Fdrone-matrixchat-notify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpotlightKid%2Fdrone-matrixchat-notify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SpotlightKid","download_url":"https://codeload.github.com/SpotlightKid/drone-matrixchat-notify/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpotlightKid%2Fdrone-matrixchat-notify/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31707953,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-12T06:22:27.080Z","status":"ssl_error","status_checked_at":"2026-04-12T06:21:52.710Z","response_time":58,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ci","docker-image","drone-ci","drone-plugin","matrix-chat","matrix-nio","notification","python"],"created_at":"2024-11-25T17:22:04.841Z","updated_at":"2026-04-12T07:37:14.553Z","avatar_url":"https://github.com/SpotlightKid.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# drone-matrixchat-notify\n\n[![MIT License](https://img.shields.io/github/license/SpotlightKid/drone-matrixchat-notify?label=License)](https://github.com/SpotlightKid/drone-matrixchat-notify/blob/master/LICENSE)\n[![GitHub tag (with filter)](https://img.shields.io/github/v/tag/SpotlightKid/drone-matrixchat-notify?filter=v*.*.*\u0026logo=github\u0026label=Latest%20version)](https://github.com/SpotlightKid/drone-matrixchat-notify/tags)\n[![Docker image version](https://img.shields.io/docker/v/spotlightkid/drone-matrixchat-notify?logo=docker\u0026label=Docker+image)](https://hub.docker.com/r/spotlightkid/drone-matrixchat-notify)\n[![GitHub stars](https://img.shields.io/github/stars/SpotlightKid/drone-matrixchat-notify?logo=github\u0026label=GitHub)](https://github.com/SpotlightKid/drone-matrixchat-notify)\n[![GitLab stars](https://img.shields.io/gitlab/stars/SpotlightKid%2Fdrone-matrixchat-notify?logo=gitlab\u0026label=GitLab)](https://gitlab.com/SpotlightKid/drone-matrixchat-notify)\n[![GitHub issues](https://img.shields.io/github/issues/SpotlightKid/drone-matrixchat-notify?logo=github\u0026label=Issues)](https://github.com/SpotlightKid/drone-matrixchat-notify/issues)\n\nA [drone.io] [plugin] to send notifications to Matrix chat rooms from CI\npipeline steps. Supports *Jinja* message templates and *Markdown* rendering.\n\nExample pipeline configuration:\n\n```yaml\nkind: pipeline\ntype: docker\nname: default\n\nsteps:\n- name: build\n  image: alpine\n  commands:\n  - ./build\n\n- name: notify\n  image: spotlightkid/drone-matrixchat-notify\n  settings:\n    homeserver: 'https://matrix.org'\n    roomid: '!xxxxxx@matrix.org'\n    userid: '@drone-bot@matrix.org'\n    password:\n      from_secret: drone-bot-pw\n    markdown: 'yes'\n    template: |\n      `${DRONE_REPO}` build #${DRONE_BUILD_NUMBER} status: **${DRONE_BUILD_STATUS}**\n\n      ${DRONE_PULL_REQUEST_TITLE}](${DRONE_COMMIT_LINK})\n```\n\n## Configuration settings\n\n### Required\n\n* `roomid` *(required)*\n\n    ID of matrix chat room to send messages to (ID, not alias).\n\n* `userid` *(required)*\n\n    Matrix user ID on homeserver to send message as (ID, not username).\n\n* `password` *(required)*\n\n    Password to use for authenticating the user set with `userid`. Either a\n    password or an access token is required.\n\n* `accesstoken` *(required)*\n\n    Access token to use for authentication instead of `password`. Either an\n    access token or a password is required.\n\n### Optional\n\n* `allowed_attrs` *(default:* [`DEFAULT_ALLOWED_ATTRS`]*)*\n\n    List or string with comma-separated list of HTML attribute names or\n    dict mapping tag names to lists of attributes names.\n\n    See the bleach documentation on [allowed attributes] for more information.\n\n* `allowed_tags` *(default:* [`DEFAULT_ALLOWED_TAGS`]*)*\n\n    List or set or string with comma-separated list of HTML tag names. HTML\n    tags not included will be stripped from the HTML output generated by\n    rendering a Markdown message template.\n\n    Note that the default list does not include any tags, which allow to load\n    external resources when the generated HTML is displayed, notably `img`\n    is not included.\n\n* `deviceid`\n\n    Device ID to send with access token.\n\n* `devicename`\n\n    Device name to send with access token.\n\n* `homeserver` *(default:* `https://matrix.org`*)*\n\n    The Matrix homeserver URL.\n\n* `jinja`\n\n    If set to `yes`, `y`, `true`, `t`, `on` or `1`, the message template is\n    rendered with the [Jinja] templating engine (instead of performing simple\n    placeholder substitution). The template context is controlled by the\n    `pass_environment` setting, same as with non-Jinja templates, but\n    placeholders use a different syntax (example: `{{DRONE_REPO}}`), so the\n    `template` setting should be changed to be a valid Jinja template string\n    when this is enabled.\n\n    Using this feature requires the `jinja2` Python module to be available\n    (it is installed by default in the plugin's docker image).\n\n* `markdown`\n\n    If set to `yes`, `y`, `true`, `t`, `on` or `1`, the message resulting from\n    template substtution is considered to be in Markdown format and will be\n    rendered to HTML and sent as a formatted message with the format set to\n    `org.matrix.custom.html`.\n\n    Using this feature requires the `markdown` and `bleach` Python modules to\n    be available (they are installed by default in the plugin's docker image).\n\n* `markdown_extensions` *(default:* `admonition, extra, sane_lists, smarty`)\n\n    Comma-separated list of enabled Markdown extensions. See this\n    [list of extensions] for valid extension names. Including an invalid\n    extension name in this list will disable Markdown rendering.\n\n* `pass_environment` *(default:* `DRONE_*`*)*\n\n    Comma-separated white-list of environment variable names or name patterns.\n    Patterns are shell-glob style patterns and case-sensitive.\n\n    Only environment variables matching any of the given names or patterns will\n    be available as valid placeholders in the message template.\n\n* `template` *(default:* `${DRONE_BUILD_STATUS}`*)*\n\n    The message template. Valid placeholders (example: `${DRONE_REPO}`) will be\n    substituted with the values of the matching environment variables (subject\n    to filtering according to the `pass_environment` setting).\n\n    See this [reference] for environment variables available in drone.io CI\n    pipelines.\n\n\n\n[`DEFAULT_ALLOWED_ATTRS`]: https://github.com/SpotlightKid/drone-matrixchat-notify/blob/master/matrixchat-notify.py#L28\n[`DEFAULT_ALLOWED_TAGS`]: https://github.com/SpotlightKid/drone-matrixchat-notify/blob/master/matrixchat-notify.py#L35\n[allowed attributes]: https://bleach.readthedocs.io/en/latest/clean.html#allowed-attributes-attributes\n[drone.io]: https://drone.io/\n[jinja]: https://jinja.palletsprojects.com/\n[list of extensions]: https://python-markdown.github.io/extensions/\n[plugin]: https://docs.drone.io/plugins/overview/\n[reference]: https://docs.drone.io/pipeline/environment/reference/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspotlightkid%2Fdrone-matrixchat-notify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspotlightkid%2Fdrone-matrixchat-notify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspotlightkid%2Fdrone-matrixchat-notify/lists"}