GitHub

GitHub is where software teams host code and track issues. Connecting GitHub to Resool lets agents open a GitHub issue straight from a customer conversation, with labels, the contact and a link back to the chat, and then see whether the issue is still open or already closed. Workflows can open GitHub issues automatically too.

#What you can do with GitHub

In the Inbox

• Create issue in a repository from a conversation, with a title, description and labels. The contact and a link to the conversation are added to the issue.
• See the issues opened for the contact from Resool, each with its number, date and status (Open or Closed).
• View in GitHub to open an issue in a new tab.

In Workflows

• The Create GitHub issue step opens an issue in a repository with a link to the conversation.

#Before you begin

• You need a GitHub account with access to the repositories where you'll open issues. Private repositories work too.
• In Resool, only workspace Owners and Admins can connect apps.

#How to connect GitHub to Resool

1. Go to Settings › Apps and open the Developer tools tab.
2. On the GitHub card, click Connect.
3. The Connect GitHub dialog lists what Resool will be able to do after you approve: see your repositories and their labels; open issues (GitHub's repo scope, needed for private repositories); and see whether those issues are open or closed. Click Continue.

Screenshot placeholder

Settings › Apps › GitHub › Connect

The "Connect GitHub" dialog with the description, the "After you approve on GitHub, Resool will be able to:" list (three items), and the Cancel and Continue buttons.

File: screenshots/github-connect-dialog.png

1. Sign in to GitHub in the window that opens and click Authorize.
2. You're returned to Resool and see GitHub connected. The card shows the Manage and Disconnect buttons.

#How to set the default repository

1. Click Manage on the GitHub card to open GitHub settings.
2. Under Defaults, pick the Repository. You can search when you have many repositories.
3. Save with the save bar at the bottom.

The default repository is used by Create issue in the Inbox and by workflow steps that don't pick their own.

Screenshot placeholder

Settings › Apps › GitHub › Manage

The "GitHub settings" side panel with the Defaults section and a Repository picker set to an owner/repo name.

File: screenshots/github-settings-sheet.png

#How to create a GitHub issue from the Inbox

1. Open a conversation in the Inbox and click the GitHub icon in the contact details rail.
2. Click Create issue. The New GitHub issue form opens.
3. Check or change the Repository, then add Labels from that repository with Add a label.
4. Write a Title and a Description. The contact and a link to this conversation are added automatically.
5. Click Create. You see Created in GitHub, and the issue appears in the panel.

Screenshot placeholder

Inbox › open a conversation › GitHub icon › Create issue

The "New GitHub issue" form with a repository picked, two labels (bug, customer), a Title and Description filled in, the hint "The contact and a link to this conversation are added.", and the Cancel and Create buttons.

File: screenshots/github-create-issue.png

The panel lists the issues opened for the contact with their number and Open or Closed status. If there are none yet, you see No GitHub issues for this contact yet. The same panel opens from the Apps card on the contact's page.

#How to open GitHub issues from Workflows

1. Open a workflow and add a step. Under Tasks & docs, choose Create GitHub issue.
2. Pick the Repository, or leave it on the default to use the one from GitHub settings.
3. Write the Title and Body. Both can use variables, such as the contact's name.
4. Add Labels if you want (up to 20).
5. Publish the workflow.

If GitHub isn't connected, the step shows Connect GitHub with a link to the Apps page.

Screenshot placeholder

Workflows › open a workflow › Create GitHub issue step

The step settings with a Repository picked, a Title containing a contact-name variable, a Body, two labels, and the note that the contact and a link to the conversation are added.

File: screenshots/github-workflow-step.png

#How to disconnect GitHub

1. Go to Settings › Apps and click Disconnect on the GitHub card.
2. Confirm in the Disconnect GitHub? dialog.

Issues already on GitHub stay there. Workflow steps that open GitHub issues stop working until you connect again.

#FAQ and troubleshooting

#A repository doesn't appear in the picker.

The GitHub account you connected can't see it. For an organization's repositories, the organization may need to approve the Resool app in its GitHub settings. Then reopen the picker.

#Which issues does the panel show?

Only issues opened from Resool for that contact. Issues created directly on GitHub aren't listed.

#I don't see Create issue.

Your role doesn't allow managing contacts. Ask an Owner or Admin.

#What's next?

• Jira
• Workflow steps
• Getting started with apps