Notify Matrix about Completion of a GitHub Action Workflow

This action sends a message into a matrix room saying if a workflow succeeds or fails, and also sends reactions for each of the jobs with their status.

Put this action at the end of your workflow so it looks like this:

jobs:
  pass:
    runs-on: ubuntu-latest
    steps:
      - run: exit 0

  fail:
    runs-on: ubuntu-latest
    steps:
      - run: exit 1

  notify:
    if: always()
    runs-on: ubuntu-latest
    needs: [pass, fail]
    steps:
      - uses: Cadair/matrix-notify-action@main
        id: message
        with:
          matrix_token: ${{ secrets.matrix_access_token }}
          github_token: ${{ secrets.GITHUB_TOKEN }}
          homeserver: 'https://matrix.org'
          roomid: '!alsdkjaslkdakldjas:matrix.org'

      - name: Print the event ID
        run: echo "Sent Matrix Event '${{ steps.message.outputs.eventId }}'"

When the action is run, it collects all the completed jobs in the workflow and uses those to compute the status of the workflow and send the reactions for the individual jobs.

The result is something which looks like this:

Other Configuration Options

Ignore Pattern

If you do not wish to post reactions for all of the jobs executed by the workflow you can specify a regular expression which is an ignore pattern, matched against the name. To enable this add something similar to the following to the with: block

ignore_pattern: '.*long.*'

Summarise Successful Jobs

If you have a large build matrix, you can choose to only see the number of successful jobs, and just have individual reactions for jobs which did not conclude with success. This can by adding the following to the with: block:

summarise_success: true

Add a workflow description to the message

If you want to add a custom note about the build to the message you can add the following to the with: block:

workflow_description: "A passing test"