Pairify
Overview
This document provides information on what Pairify is and how to use it to record pairing sessions.
What is Pairify?
Pairify is a Slack bot application that will scan monitored Slack channels on a schedule for any conversations reacted with (:pairify:
).
It will then extract all Zendesk URLs, Slack participants/mentions and automatically create a pairing issue with the Zendesk URLs, participants (converted to GitLab.com usernames) and closes out the issue.
Using Pairify
NOTE: For Pairify to correctly map your Slack user to your GitLab.com user, you must configure your Slack profile’s GitLab.com profile field. See edit your profile for more details.
To incorporate Pairify into your pairing session workflow:
-
Create a thread in one of the supported channels and pair with your colleagues!
-
Ensure that the thread conversation contains the following information:
a. All Zendesk ticket URLs worked on
b. All participants in the pairing session need to comment on the thread, or mentioned
@slack_username
in the thread -
Optional. Specify the pairing session type.
-
React to the thread with the (
:pairify:
) emoji to mark a conversation for Pairify to process.
You then need to wait for the next scheduled execution of Pairify, as explained in how Pairify works.
How Pairify works
Pairify executes every 30 minutes via a scheduled pipeline. When the pipeline begins, Pairify will search all monitored channels
for any conversation reacted with the (:pairify:
) emoji that was created within the last 6 hours.
Pairify will then:
- Extract any Zendesk URLs, participants and mentions within the conversation
- Convert all Slack users to their GitLab.com counterparts
- Create a GitLab issue in the Support Pairing project with the details extracted. The
pairify
label will be automatically applied to the issue, along with any other labels determined during processing. - Creates a message on the conversation thread indicating that the conversation has been processed. The response will also include a link to the issue created
- React to the conversation with an (
:issue-created:
) emoji so the conversation is not processed again on subsequent executions.
Specifying the pairing session type
Pairify can apply additional labels to pairing issues to indicate the pairing session type if you react with additional emojis.
The reactions in this table are mutually exclusive - Pairify will only process the first reaction added to the conversation if multiple reactions are found:
Emoji | Shortcode | Description |
---|---|---|
:crush: |
Adds the crush label to the pairing issue |
|
:office-hours: |
Adds the office hours label to the pairing issue |
To ensure these reactions are picked up by Pairify, you should add these reactions before adding the :pairify:
emoji to your conversation.
Channels monitored by Pairify
Pairify can be used in the following Slack channels:
#spt_pairing
#spt_amer
#spt_emea_shift-1
#spt_emea_shift-2
#spt_emea_shift-3
#spt_us-government
#spt_us-gov-evening-overnight
#support_team-chat
- Support Pod channels
Troubleshooting
- Refer to the troubleshooting section in the Pairify project.
- Review the issue tracker as you might be encountering a known issue.
ab6ef066
)