Send GitHub pull requests to Slack messages

• Overview
• How the template works
• How to use the template
  • Step 1: Create GitHub OAuth 2.0 credentials
  • Step 2: Create Slack OAuth 2.0 credentials
  • Step 3: Use this workflow template
  • Step 4: Define variables
  • Step 5: Define Webhook settings

Overview

This workflow serves as a seamless bridge between GitHub and Slack, facilitating efficient communication and collaboration among development teams. Specifically, it automatically sends notifications to designated Slack channels whenever new pull requests are created in GitHub repositories.

By integrating these two platforms, teams can stay updated on the progress of code changes and foster timely discussions and reviews.

How the template works

1. GitHub webhook integration: Upon receiving a created or reopened GitHub pull request event, it retrieves relevant details such as the title, author, and repository name to prepare for notification.

2. Slack notification preparation: Using the retrieved pull request details, the workflow formats the information into a concise and informative message suitable for Slack. This ensures that the Slack notifications provide essential context and facilitate quick understanding and action by team members.

3. Slack message dispatch: Once the Slack notification is prepared, the workflow dispatches it to the designated Slack channel(s). Team members subscribed to these channels receive real-time updates on new pull requests, enabling them to stay informed and collaborate effectively.

How to use the template

Step 1: Create GitHub OAuth 2.0 credentials

1. Ensure you have set up GitHub OAuth 2.0 and have access to client ID and client secret.

2. Log in to the SimWorkflow.

3. Navigate to Credentials.

4. Click Create credentials button.

5. Select OAuth 2.0 tab.

6. Select GitHub from the Provider dropdown.

7. Enter GitHub in the Name field.

8. Enter the Client ID in the Client ID field.

9. Enter the Client secret in the Client secret field.

10. Enter repo to the Scopes field.

11. Click Create credentials button.

Step 2: Create Slack OAuth 2.0 credentials

1. Ensure you have set up Slack OAuth 2.0 and have access to client ID and client secret.

2. Navigate to Credentials.

3. Click Create credentials button.

4. Select OAuth 2.0 tab.

5. Select Slack from the Provider dropdown.

6. Enter Slack to the Name field.

7. Enter the Client ID in the Client ID field.

8. Enter the Client Secret in the Client secret field.

9. Enter chat:write to the Scopes field.

10. Click Create credentials button.

Step 3: Use this workflow template

1. Click Use this template button on the top right of this page.

2. Click Get pull request task and select Configuration tab.

3. Select GitHub (OAuth 2.0) for Credentials field.

4. Click Slack task and select Configuration tab.

5. Select Slack (OAuth 2.0) for Credentials field.

6. Click Save button.

7. Toggle the Enable checkbox to enable the workflow definition.

Step 4: Define variables

1. Navigate to Workflow definitions.

2. Click Variables menu item from the three dots (more options) menu of the Send GitHub pull requests to Slack messages workflow definition.

3. Enter githubWebhookSecret to the Variable key field.

4. Enter the GitHub webhook secret token to the Variable value field.

5. Click Save variable button.

6. Enter slackChannelId to the Variable key field.

7. Enter the Slack channel ID in the Variable value field.

8. Click Save variable button.

Step 5: Define Webhook settings

1. Navigate to Workflow definitions.

2. Click Webhook settings menu item from the three dots (more options) menu of the Send GitHub pull requests to Slack messages workflow definition.

3. Turn on Webhook on field.

4. Copy the Webhook endpoint URL, we'll paste it later.

5. Select a user for User to start the workflow as field.

6. Enter the following JavaScript in the Validate the payload field:

   'sha256=' + Swf.hmacSha256Hex($['swf:variables'].githubWebhookSecret, $.body) === $.headers['x-hub-signature-256']
   

   The system will use the workflow definition variable githubWebhookSecret to verify that a webhook delivery is from GitHub.

7. Click Save webhook settings button.