Signed-off-by: Meredith Lancaster <malancas@users.noreply.github.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com> Co-authored-by: Felicity Chapman <felicitymay@github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Laura Coursen <lecoursen@github.com> Co-authored-by: AlonaHlobina <54394529+AlonaHlobina@users.noreply.github.com> Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com> Co-authored-by: Jules <19994093+jules-p@users.noreply.github.com> Co-authored-by: Siara <108543037+SiaraMist@users.noreply.github.com> Co-authored-by: Kelly Arwine <kellyarwine@github.com> Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> Co-authored-by: Jon Janego <jonjanego@github.com> Co-authored-by: Jules Porter <jules-p@users.noreply.github.com> Co-authored-by: hubwriter <hubwriter@github.com> Co-authored-by: Laurenzo <lsto@github.com> Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com> Co-authored-by: Vanessa <vgrl@github.com> Co-authored-by: Melanie Yarbrough <11952755+myarb@users.noreply.github.com> Co-authored-by: Claire W <78226508+crwaters16@users.noreply.github.com> Co-authored-by: Felix Guntrip <guntrip@github.com> Co-authored-by: James Fletcher <42464962+jf205@users.noreply.github.com> Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com> Co-authored-by: Tim Rogers <timrogers@github.com> Co-authored-by: docs-bot <77750099+docs-bot@users.noreply.github.com> Co-authored-by: Guillaume Perrot <guperrot@github.com> Co-authored-by: Mark Tareshawty <tarebyte@github.com> Co-authored-by: Hirsch Singhal <1666363+hpsin@users.noreply.github.com> Co-authored-by: Emily Gould <4822039+emilyistoofunky@users.noreply.github.com> Co-authored-by: Sunbrye Ly <56200261+sunbrye@users.noreply.github.com> Co-authored-by: PJ Quirk <pjquirk@github.com> Co-authored-by: Steve Ward <steveward@github.com> Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com> Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com> Co-authored-by: SiaraMist <siaramist@github.com> Co-authored-by: Tomoko Tanaka <28242405+tallzeebaa@users.noreply.github.com> Co-authored-by: a1exmozz <187176404+a1exmozz@users.noreply.github.com> Co-authored-by: Meredith Lancaster <malancas@users.noreply.github.com> Co-authored-by: Sarah Schneider <sarahs@users.noreply.github.com> Co-authored-by: Andy Barnes <kurgol@github.com> Co-authored-by: Sheena Ganju <sheenyg@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Sydney Wilson <86739163+swilson15@users.noreply.github.com> Co-authored-by: Robert Sese <734194+rsese@users.noreply.github.com> Co-authored-by: Vimala Moger <166641453+VimalaMoger@users.noreply.github.com> Co-authored-by: Sharra-writes <sharra-writes@github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Jenni C <97056108+dihydroJenoxide@users.noreply.github.com> Co-authored-by: Greg Mondello <72952982+gmondello@users.noreply.github.com> Co-authored-by: Mia Arts <107727642+its-mia@users.noreply.github.com> Co-authored-by: sunbrye <sunbrye@github.com> Co-authored-by: Lorenz Vanthillo <lorenz.vanthillo@gmail.com> Co-authored-by: Eboni <32157169+EboniLM@users.noreply.github.com> Co-authored-by: Junko Suzuki <pnsk@github.com> Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> Co-authored-by: heiskr <1221423+heiskr@users.noreply.github.com> Co-authored-by: Patrick Knight <patrick-knight@github.com> Co-authored-by: T. Greg Doucette <58960990+LawDevNull@users.noreply.github.com> Co-authored-by: Evan Bonsignori <ebonsignori@github.com> Co-authored-by: Robert Justin Monzingo <robertjmonzingo@gmail.com> Co-authored-by: John Coleman <thenewcoke@gmail.com> Co-authored-by: Brendan Scott-Smith <117171930+bss-mc@users.noreply.github.com> Co-authored-by: Chad Bentz <1760475+felickz@users.noreply.github.com> Co-authored-by: Justin Alex <1155821+jusuchin85@users.noreply.github.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: azenMatt <7584089+azenMatt@users.noreply.github.com> Co-authored-by: Felix Guntrip <stevecat@github.com> Co-authored-by: timrogers <116134+timrogers@users.noreply.github.com> Co-authored-by: John Clement <70238417+jclement136@users.noreply.github.com> Co-authored-by: vaindil <vaindil@github.com> Co-authored-by: Matthew Isabel <matthewisabel@github.com> Co-authored-by: Matthew Isabel <matthew.isabel@gmail.com>
9.3 KiB
title, shortTitle, intro, versions, topics
| title | shortTitle | intro | versions | topics | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Using GitHub in Slack | Use GitHub in Slack | Learn how to use GitHub in Slack to improve collaboration and streamline your workflow. |
|
|
The {% data variables.product.github %} integration for Slack allows you to connect your {% data variables.product.github %} account to the {% data variables.product.github %} app in Slack. Once connected, you can use slash commands to interact with {% data variables.product.github %}, receive notifications about repository activity, and collaborate with your team directly within Slack.
Connecting your {% data variables.product.github %} account to the {% data variables.product.github %} app in Slack
[!NOTE] Before you can connect your accounts, an admin for your Slack workspace must have installed the {% data variables.product.github %} app. See AUTOTITLE.
- In Slack, start a direct message with the {% data variables.product.github %} app.
- The direct message will be pre-populated with a welcome message and a link to connect your {% data variables.product.github %} account. Follow the prompts on screen in Slack, and in {% data variables.product.github %} in your browser, to authenticate and authorize the connection.
Once your {% data variables.product.github %} account is connected, Slack will show you a list of available commands and features you can use.
Using Slash commands to interact with {% data variables.product.github %} in Slack
To use a slash command, type /github followed by the command you want to execute in the message input field of any Slack channel or direct message where the {% data variables.product.github %} app is present. To invite the app to a channel, type /invite @github in the channel.
| Command | Description |
|---|---|
/github help |
Displays a list of essential commands and their descriptions. |
/github subscribe owner/repo |
Subscribes the channel to notifications for the specified repository. |
/github unsubscribe owner/repo |
Unsubscribes the channel from notifications for the specified repository. |
/github subscribe list |
Lists all repositories the channel is subscribed to. |
/github open owner/repo |
Opens an issue in the specified repository. You will be prompted to provide a title and description for the issue. |
/github close [issue link] |
Closes the specified issue as completed. |
/github close [issue link] reason:"not planned" |
Closes the specified issue with a reason. Replace "not planned" with your reason. |
/github reopen [issue link] |
Reopens the specified issue. |
[!NOTE] When you subscribe a channel to a repository, the channel will receive notifications for all
open,close, andreopenevents on pull requests and issues in that repository. The channel will also receive notifications of anypushevents directly to the repository's default branch.
{% ifversion fpt or ghec %}
Initiating {% data variables.copilot.copilot_coding_agent %} sessions within Slack
The {% data variables.product.github %} app also integrates {% data variables.copilot.copilot_coding_agent %} into Slack. You can use this functionality to summon {% data variables.copilot.copilot_coding_agent %} in threads where important discussions are taking place, and ask it to make changes based on the context of those discussions. See: AUTOTITLE.
{% endif %}
Mentions in Slack
When you subscribe to a repository in Slack, you will see yourself mentioned in notifications for repository events in which you have been referenced. For example, if you are assigned to an issue, or mentioned in a comment, you will see yourself mentioned in the notification in Slack.
Mentions require you to be logged in to your {% data variables.product.github %} account through the {% data variables.product.github %} app in Slack. This enables {% data variables.product.github %} to map your Slack identity to your {% data variables.product.github %} identity. See Connecting your {% data variables.product.github %} account to the {% data variables.product.github %} app in Slack.
Note
If you have multiple Slack workspaces where you use the {% data variables.product.github %} app, mentions will only work in the workspace where you logged in to your {% data variables.product.github %} app most recently. If you log in to your {% data variables.product.github %} app in a different workspace, mentions will stop working in the previous workspace.
The following are scenarios in which you will be mentioned:
- You are assigned to an issue.
- Your review is requested on a pull request.
- You are mentioned in a pull request, issue description, comment, or discussion.
- Your review is requested on a deployment.
- You receive a scheduled reminder for a pull review request.
You can see a summary of your {% data variables.product.github %} mentions in the "Mentions" view in Slack. For more information, see Triage notifications in the Activity tab in the Slack documentation.
Threading conversations
Notifications for each issue or pull request are grouped into a thread in Slack. The parent message always shows the latest status of the issue or pull request, along with other meta-data like title, description, assignees, reviewers, labels and checks. Threading helps keep conversations organized, making it easier to follow updates and discussions related to a specific issue or pull request. When the state of an issue or pull request changes, the associated reply is posted both in the thread and in the channel, so that everyone in the channel is aware of the update.
You can disable threading for issue and pull request notifications in individual channels.
- In the Slack channel where you want to disable threading, type
/github settings. - In the settings menu, to the right of "Disable threading for Pull Request and Issue notifications", click Disable.
You, or any other member of the channel, can re-enable threading at any time by following the same steps and clicking Enable in the settings menu.
Broadcasting comments and reviews to the Slack channel
By default, comments and reviews will only show up in their related thread. If you want the channel members to see them instead of just those who are participants of the issue, you can opt-in to broadcasting with the following commands:
-
For comment broadcasting, use
/github subscribe owner/repo comments:"channel" -
For review broadcasting, use
/github subscribe owner/repo reviews:"channel"
Unfurling links to {% data variables.product.github %} activities in Slack
Link previews provide additional context when sharing links to {% data variables.product.github %} activities in Slack. Link previews are shown in Slack for the following {% data variables.product.github %} activities:
- Pull requests
- Issues
- Directly linked comments
- Code blobs with line numbers
- Organizations, repositories, and users
Previews of links will not be shown if any of the following apply:
- Link previews are disabled in your Slack workspace. See Share links and set preview preferences in the Slack documentation.
- The same link has already been shared in the channel in the past 30 minutes.
- 3 or more links are shared in the same message.
- The repository is private, and the user who shared the link:
- Has not connected their {% data variables.product.github %} account to the {% data variables.product.github %} app in Slack.
- Asked not to show link previews when prompted.
- The {% data variables.product.github %} app is not in the channel where the link is shared. See Using slash commands to interact with GitHub in Slack.
{% ifversion fpt or ghec %}
Scheduling reminders for pull request reviews
You can schedule reminders for pull request reviews in Slack. Reminders can be sent to you directly in a direct message with the {% data variables.product.github %} app, or to a channel where the {% data variables.product.github %} app is present. For example, you can schedule a reminder to be sent to you in a direct message every weekday at 10 AM including all open issues that are assigned to you.
You can configure scheduled reminders for yourself, your team, or your entire organization. For more information, see:
{% endif %}