Using GitHub App

After installing the GitHub app, users in your workspace can start using it. Interaction with the GitHub app is achieved using slash commands.

The /github slash command is used to initiate actions with the GitHub app. To run any Github command, a user is required to authenticate first, using /github login.

• /github : Shows the GitHub App help

• /github login: Log in to the GitHub app using GitHub OAuth

• /github logout: Logs a user out

• /github me: Shows the user's GitHub profile and issues

• /github search: Searches for an issue and a pull request

• /github issue: Adds a new issue to a GitHub repository

• /github issues: Assign and share issues

• /github subscribe: View/Add/Delete/Update repository subscriptions

• /github <username>/<repository name>: Shows an interactive interface to fetch repository data

• /github <username>/<repository name> repo: Get the details of a repository

• /github <username>/<repository name> issues: List out the issues in a repository

• /github <username>/<repository name> contributors: Get a list of contributors a repository has

• /github <username>/<repository name> pulls: Get Recent Pull Requests of a Repository

• /github <username>/<repository name> pulls <pull number>: Review a pull request

• /github <username>/<repository name> subscribe: Subscribe to all events of a repository

• /github <username>/<repository name> unsubscribe: Unsubscribe from all events of a repository

GitHub App Authentication

Login

When the slash command /github login is sent,

• You receive a message from the github.bot with a GitHub login button

• Click the button to authenticate with your GitHub account.

• A message is received on successful authentication

Logout

To log out,

• Type the slash command /github logout

• This removes the current unauthenticated user.

GitHub App Functions

/github me

It returns your profile details with issues assigned to you.

• Click Issues to see a list of issues assigned to you.

• Click on Share Profile to select and share your profile details within a chat.

/github search

It lets you search for issues or pull requests in a specified repository.

• Specify the search parameters and Search.

/github issue

Create a new issue in a GitHub repository.

• Enter the Full Repository Name you wish to create the issue in, and click Next

• Fill in the issue details and Create Issue.

• The issue gets created, and a link to it is provided.

/github issues

This lets you manage the issues on a GitHub repository.

• Enter the Full Repository Name you wish to see the issue in, and click Next

• A list of issues on the repository is seen. From here you can

  • View the issue directly on GitHub

  • Assign to issue to someone

  • Add the issue

/github subscribe

It allows you to manage subscriptions on repositories. When you subscribe to a repository event, you receive a message within the Rocket.Chat room from which each event gets triggered.

• Click Add Subscriptions to add a new subscription

  • Specify the repository, the events to subscribe to, and Subscribe.

  • You get a message confirming the subscription.

• Click Delete Subscriptions to delete existing subscriptions.

  • Select the subscription and Unsubscribe.

  • You receive a message about the unsubscription.

• Click Refresh to refresh the list of subscriptions.

/github <username>/<repository name>

To retrieve information about a repository,

• Click Overview to see the repository overview.

• Click Issues to get all the repository issues.

• Click Contributors to get a list of all the top contributors.

• Click Pull Requests to see the open pull requests.

GitHub App Repository Actions

/github <username>/<repository name> repo

• Returns a detailed overview of a repository.

/github <username>/<repository name> issues

To return a list of issues open on a current repository.

• Click on any to open the issue in a new tab.

/github <username>/<repository name> contributors

To return a list of contributors under a repository.

• Click on a user to open their GitHub profile on a new tab.

/github <username>/<repository name> pulls

To return a list of open pull requests on a repository.

• Click on a PR to open it in a new tab.

/github <username>/<repository name> pulls <pull number>

To review a specific pull request using its PR number,

• Click View Changes to see the changes made by that pull request

• View File lets you see the file(s) that have been affected by the pull request.

• Click on Comments to view the comments under the PR where you Add Comment.

• Click on Merge to specify the merge request detail and Merge the PR.

/github <username>/<repository name> subscribe

• Subscribe to all the events of a repository and receive messages in that channel when the event gets triggered.

/github <username>/<repository name> unsubscribe

• Unsubscribe from all events of a repository.