Plugin: hook-matrix

Posts release notifications to a Matrix room. It works well for teams using Matrix or Element for release coordination and status updates.

Installation

go install github.com/SemRels/hook-matrix@latest

Each plugin is a standalone Go binary. Keep it on your PATH or reference it with path: in .semrel.yaml. If you keep secrets in a .env file, load them with semrel --env-file .env release.

Configuration

version: 1
plugins:
  - name: hook-matrix
    path: hook-matrix
    args:
      homeserver: 'https://matrix.example.com'
      token: '${{ env.MATRIX_TOKEN }}'
      room_id: '!release:matrix.example.com'
      message_template: 'Released {{ .TagName }} from {{ .Branch }}'

Environment Variables

Name	Required	Default	Description
SEMREL_PLUGIN_HOMESERVER	yes	—	Matrix homeserver base URL.
SEMREL_PLUGIN_TOKEN	yes	—	Access token used to send messages.
SEMREL_PLUGIN_ROOM_ID	yes	—	Destination room ID, such as !room:server.
SEMREL_PLUGIN_MESSAGE_TEMPLATE	no	plugin-defined	Optional Matrix message template.

Release Context Variables

• SEMREL_TAG_NAME
• SEMREL_NEXT_VERSION
• SEMREL_CURRENT_VERSION
• SEMREL_BUMP
• SEMREL_BRANCH
• SEMREL_CHANGELOG
• SEMREL_DRY_RUN

Example Output

A release can post a message like Released v1.4.0 from main followed by the generated changelog into the configured Matrix room.

Source

• SemRels/hook-matrix