GitHub App

Last updated last month

Everything you need to know about SlashDeploy GitHub App.

Overview

SlashDeploy GitHub Application is configured on per-repository basis, which enables us to receive deployment related events from GitHub and notify your team about deployments in Slack. We also use a GitHub OAuth App to be able to link your GitHub account to the installed Slack team and create deployments on behalf of your GitHub account.

Adding repositories

Only repositories that have been added to our GitHub application can be deployed with SlashDeploy. To add new repositories, click on Go to GitHub button in the top right corner of our Web app, or follow this link.

Requested permissions

When you add one of your repositories to our GitHub application, you will be requested to grant the following permissions.

Permission

Access

Purpose

Checks

Read

Allows SlashDeploy to read checks of the repository.

Repository contents

Read

Even though it allows SlashDeploy to read your repository, we never clone, nor access your source code. The permission is required to be able to receive GitHub Push events, in order to trigger auto-deployments.

Deployments

Read & write

Allows SlashDeploy to receive GitHub Deployment and Deployment Status events. Additionally, allows us to create auto-deployments on behalf of our GitHub application, in case commit author is not a SlashDeploy user.

Single file

Read

Allows SlashDeploy to access a single file, .slashdeploy.yml configuration.

Commit statuses

Read

Allows SlashDeploy to read commit status checks and receive GitHub Status events.