Test results to Slack GitHub Action

This GitHub Action will send Slack messages with the tests results.

How it works

The action will send notifications with the workflow status grouped by a unique identifier depending on the trigger event. Grouping means that a main message will be created and this message will be updated with new status information as long as new workflows will run for the same event.

For pull_request, the notifications will be grouped by PR number. For push, the notifications will be grouped by commit id. For schedule event there will be no grouping. Each new run will have its own main message.

If workflow failed and no main message exists, a main message is created and then a reply is sent with the failed run details.

If workflow failed and a main message exists, the main message is updated with the latest info and a reply is sent with the new failed run details.

If workflow conclusion is success and a main message exists, the main message gets updated with the latest status and run info.

If workflow conclusion is success and no main message is found nothing is sent.

Usage

Example

name: Tests

on:
  pull_request:
  push:

jobs:
  run-tests:
    strategy:
      matrix:
        suite: ["suite-1", "suite-2"]
  
    steps:
      - name: "Run tests"
        run: [...] # Run tests for suite ${{ matrix.suite }}

      - name: Upload test artifacts
        uses: actions/upload-artifact@v4
        with:
          name: test-output-${{ matrix.suite }}

  slack-notification:
    name: 'Send Slack notification'
    runs-on: ubuntu-latest
    needs: run-tests
    # Notify even if tests failed.
    if: ${{ !cancelled() }}
  
    steps:
      - name: Download test artifacts
        uses: actions/download-artifact@v4
        with:
          path: test-artifacts

      - name: 'Send Slack notification'
        uses: automattic/action-test-results-to-slack@v1
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          slack_token: ${{ secrets.SLACK_TOKEN }}
          slack_channel: "your Slack channel"
          slack_username: 'Slack username'
          slack_icon_emoji: 'Slack icon emoji'
          suite_name: 'Your test suite name'
          rules_configuration_path: 'path/to/rules/configuration/file'
          playwright_report_path: 'test-artifacts/**/report.json'
          playwright_output_dir: 'test-artifacts/**/results'

Inputs

The action relies on the following parameters.

• (Required) github_token is a GitHub Access Token used to access GitHub's API. The token should be stored in a secret.
• (Required) slack_token is the Auth token of a bot that is installed on your Slack workspace. See Slack token below for details. The token should be stored in a secret.
• (Required) slack_channel is the Slack channel ID where the messages will be sent to. Check the channel's details in your Slack app to find the channel ID.
• (Optional) slack_username is the Slack username the bot will use to send messages. Defaults to "GitHub Reporter".
• (Optional) slack_icon_emoji is the icon emoji to use for messages. If not set it will use your app's default icon.
• (Optional) suite_name is the name of the test suite. It will be included in the message, and it can also be used to define notification rules. See more in the Rules section.
• (Optional) rules_configuration_path is the path to the configuration file that defines the rules. See more in the Rules section.
• (Optional) playwright_report_path is the path to the JSON report, output from Playwright test runner JSON reporter. See Playwright's docs for details on how to generate this file. If specified, it will be parsed and failures details will be included in the message. You can use the glob pattern to specify multiple files. For example: playwright_report_path: 'artifacts/**/report.json'.
• (Optional) playwright_output_dir is the path to the Playwright's configured output directory, where results and attachments are saved. It is needed when the artefacts are downloaded from a previous job, and the absolute paths to attachments found in the JSON report are not valid anymore. This path will be used to convert the paths to those attachments. You can use the glob pattern. For example: playwright_output_dir: 'artifacts/**/results'

GitHub permissions required

This action needs access to list jobs for workflow runs.

For OAuth apps and classic access tokens, no special scopes are needed.

For GitHub Apps and fine-grained access tokens, that's read-only for repository "Actions" (actions).

Slack token

You will need to create a Slack bot for your workspace for the action to use. The bot will need the following scopes:

• chat:write - To post messages to the configured channel.
• chat:write.public - If the bot is not a member of the configured channel.
• chat:write.customize - For the slack_username and slack_icon_emoji parmeters to work.
• channels:history - For the bot to find its messages from previous runs to update.
• files:write - For the bot to upload PNG images (if any) along with the report.

Rules

You can configure different rules, to send notifications in multiple channels.

There are two types of rules: refs rules, used to send notifications for specific branches or tags and suite rules, used to send notifications for specific test suites.

Refs rules

You can create as many rules as you want. For each rule, you need to define the ref type (branch, tag) and ref name to match, and a list of channels to send the notification in case of a match. Optionally you can also define whether to exclude the default channel. By default, the default channel is not excluded and a notification will also be sent there. You can use glob patterns that use characters like *, **, +, ? to define ref names.

Example:

{
  "refs": [
	{
	  "type": "branch",
	  "name": "trunk",
	  "channels": [
		"CHANNEL_ID_1"
	  ],
	  "excludeDefaultChannel": true
	},
	{
	  "type": "branch",
	  "name": "releases/**",
	  "channels": [
		"CHANNEL_ID_2"
	  ]
	}
  ]
}

In the example, for runs on branch trunk, a notification will be sent to CHANNEL_ID_1. For runs on any branch matching releases/** pattern, (e.g. releases/v1.1), a notification will be sent to CHANNEL_ID_2 and to the default channel.

Suites rules

You can create as many suites rules as you want. For each rule, you need to define the suite name to match, and a list of channels to send the notification in case of a match. Optionally you and also define whether to exclude the default channel. By default, the default channel is not excluded.

Example:

{
  "suites": [
	{
	  "name": "Smoke tests",
	  "channels": [
		"CHANNEL_ID_1"
	  ]
	}
  ]
}

In the example, for runs with suite_name set to "Smoke tests", a notification will be sent to CHANNEL_ID_1 and to the default channel.

Client payload for repository_dispatch event

If the workflow is triggered by a repository_dispatch event from another repository, you may want to include some additional information about the upstream repository in the notification. This can be included in the client_payload object of the repository dispatch event. The action will parse the client_payload object and use the use information in the notification. The following properties are supported:

• sha: the sha that triggered the repository dispatch event.
• repository the repository that triggered the repository dispatch event.

These are not mandatory properties. If they are not included in the client_payload object, the notification will just contain the event_type value of the dispatch.

License

This project is licensed under the GPL2+ License - see the LICENSE.txt file for details.