Slack
Be informed about launch finish in real time in your Slack channel.
To download the Slack plugin, see Upload plugin section.
Configuration on Slack side
Create Slack workspace and channel
-
Log in to your Slack account.
-
Create Slack workspace and a channel in the workspace as shown on the screenshots below.
Create an application in Slack
-
Go to https://api.slack.com/ to create an application in Slack.
-
Click 'Your apps'.
-
Click 'Create an App'.
- Select 'From scratch'.
- Input the app name and select the created workspace → click 'Create App'.
- Choose 'Incoming webhooks' in the left menu and verify that the webhooks are activated (toggle above).
- Go to the bottom of the page and click 'Add new Webhook to Workspace'.
- You will be redirected to the page where you need to choose from available channels in your workspace where you want to post notifications.
- Select a channel and click 'Allow' button.
- Your webhook is created and can be used to create notification rules in RP.
Configuration on ReportPortal side
Upload plugin
-
Log in to ReportPortal as administrator.
-
Go to Administrate -> Plugins section.
-
Click ‘Upload’ button at the top of the page.
-
Add Slack plugin .jar file and click ‘Upload’ button.
Create notification rule
-
Go to the Project settings -> Notifications.
-
Choose Slack Notification Group.
-
Click ‘Create Rule’ button.
-
Fill the form:
Rule name – from 1 to 55 characters, mandatory field
Webhook URL – mandatory field (it is configured on the Slack side)
In case – optional field, dropdown with the options:
- Always – notification will be sent in any case.
- 10% of items have issues – notification will be sent, if more than 10% of items have issues.
- 20% of items have issues – notification will be sent, if more than 20% of items have issues.
- 50% of items have issues – notification will be sent, if more than 50% of items have issues.
- Launch has issues – notification will be sent, if at least 1 item has issues
- Launch has ‘To Investigate’ items – notification will be sent, if at least 1 item has ‘To Investigate’
Launch names – optional field
You can select only existing launch name. The field allows multi select.
Attributes – optional checkbox
When the ‘Attributes’ checkbox is checked, you can provide key/value for attributes and select the necessary radio button:
- ‘All attributes should match’
- ‘Any attribute should match’
- Click on ‘Create’ button.
How to receive notifications in Slack
When you have the plugin installed and Slack notification rules configured, you can start receiving notifications to the channel configured. For this you need to report a launch which matches the notification rule and after the launch is finished you will receive a corresponding message in the Slack channel with some details on the Launch results. Below you can find examples of how Passed and Failed launch notifications can look:
Passed Launch
Failed Launch
Disable Slack notifications
-
Go to the Project settings -> Notifications.
-
Turn OFF for Slack.
Disable plugin
-
Log in to ReportPortal as administrator.
-
Go to Administrate -> Plugins section -> Notifications tab.
-
Find Slack plugin and click on it.
-
Turn OFF.
Uninstall plugin
-
Log in to ReportPortal as administrator.
-
Go to Administrate -> Plugins section -> Notifications tab.
-
Find Slack plugin and click on it.
-
Click ‘Uninstall’ button and confirm your choice.
Thanks to Slack plugin, you can ensure that everyone stays informed about project milestones. This real-time update mechanism helps to reduce the lag in communication, allowing teams to respond promptly to any issues.