Use the GitHub app in Google Chat

Use the GitHub app in Chat to get notifications about GitHub events, such as issues, pull requests, and comments.

Before you begin

To use the GitHub app for Chat:

You need permission from your Google Workspace administrator to install apps.
You need to add the app to Chat. Learn how to find apps and add them to Chat.
You need a GitHub account.

Set up the GitHub app in Chat

Open Chat.
Open a direct message with the app or go to a space with the app.
To open the configuration window, click Sign in.
Click Configure Access Sign in to GitHub.
Complete the sign-in process then close the popup.
To update the Chat dialog, click Refresh.
Under Add Repositories, type the GitHub repository you want notifications for.
Check the boxes for the events you want notifications for.
Click Save.

You need to set up notifications in each space where you add the app. The app sends notifications to all spaces where it's a member.

Use the GitHub app in spaces

To use the app in spaces, you need to explicitly @mention the app in each message to the app (including in replies to messages from the app). The @mention confirms you're sending the message to the app and not to others in the space.

Open the Chat app .
In a space, enter “@github” followed by the command.
- When you mention @github, the message is sent to the app and not to others in the space.

Change app settings

In spaces, only the person who added the app can change the settings.

Open Chat.
Open a direct message with the app or go to a space with the app.
To open the current settings for the app, enter /github_settings.
Change the settings as needed.
Click Save.

Removing the app from a space deletes the app settings.

Learn about commands for the GitHub app in Chat

In the message field of a direct message or space with the GitHub app in Chat, you can use slash commands like:

/github_settings: Opens the settings dialogue.
/github_reminders: For personal or team open pull requests, set up and edit scheduled reminders.
/github_subscribe: Subscribes to a GitHub <repoURL> or <owner/repo>.
/github_openIssue: Opens a new GitHub issue.
/github_logout: Logs out of your GitHub account.
/github_help: Displays the help message.
/github_feedback: Send feedback about the GitHub app.

To get a full list of supported commands:

On your computer, open Chat.
Open a direct message or go to a space where the GitHub app is installed.
Enter /github_help.

Troubleshoot issues with GitHub app in Chat

If you get an error when you subscribe to real-time notifications

To set up real-time notifications in spaces, you must:

Be an organization owner of the proposed repository.
Authorize the app on the GitHub organization.
1. In your browser, go to GitHub profile settings.
2. Under “Integrations,” click Applications Authorized OAuth apps.
  - After you connect the GitHub app in Google Chat, your list of authorized apps shows "Google Chat."
3. Grant the app access to the organization you want to access.

If you receive too many notifications from the GitHub app

In the message field, enter /github_settings.
To edit your repository notifications settings, click Notification settings.
To filter the notifications, next to each notification type, click the down arrow .
- It displays additional options to filter notifications.
Check the boxes for the notifications you want.
Click Save.

If you don’t get @mentioned in scheduled reminders

To get mentioned in scheduled reminders, you must’ve connected your Google Chat account to the GitHub account.

In the message field, enter /github_settings.
To connect your account:
1. In the pop-up, click Configure access Sign in to GitHub.
2. Sign in to your GitHub account.
3. Authorize the app.
In the message you receive from the GitHub app, select Schedule reminders for your team.
In the pop-up:
1. Click Create new reminder.
2. Configure the reminder settings.
3. Click Save.

_{Google, Google Workspace, and related marks and logos are trademarks of Google LLC. All other company and product names are trademarks of the companies with which they are associated.}