Skip to content
Sliplane Logo Sliplane Logo Sliplane Docs

GitHub integration

In order to deploy new services directly from GitHub, you need to allow Sliplane to have access to the repository that you want to deploy. This can be done by clicking on the account menu in the top navbar of the app and selecting Repository Access from the dropdown. You will be redirected to GitHub to manage Sliplanes permissions.

After selecting the repository, you will be redirected back to Sliplane, where you should be able to see the repository in the dropdown while creating a new service. This can take a little bit, so If you can’t see the repository, try refreshing the list a few times.

What is the Sliplane GitHub App doing?

The Sliplane GitHub app has two main functions:

  1. To log in with Sliplane we use GitHub login. This means that your login is both faster and more secure.
  2. To deploy your code, we need to be able to read your code and metadata, and in order to deploy new versions we need to be able to create webhooks for push events on your selected repository.

Sliplane only has read access to the repositories you explicitly select, and we only create webhooks for the repositories you create services for. The webhooks are only used to trigger deployments, and are deleted when you delete the service.

What permissions does the Sliplane GitHub App need?

If you first sign up with Sliplane you will see that the GitHub app needs the following permissions:

Read access to code and metadata

This means that we can see the code of the repositories you shared with us, which is required so that we can clone the repository to your server. We also need to be able to read the metadata of the repository, such as the default branch or the used programming language.

Read and write access to repository hooks

This means that we can create webhooks for the repositories you shared with us, which is required so that we can trigger deployments when you push new code to your repository. Everytime you push code to your repository we get a message. If the message is a push event on your selected branch, we trigger a new deployent. We only create webhooks for the repositories you create services for, and we delete the webhooks when you delete the service.

Read access to organization membership

This means that we can see who is collaborating on the repositories you shared with us. This is required so that we check that you have admin access to the repository you want to deploy. The admin access is required so that we can create webhooks for the repository. We do not care or store any information about who is collaborating on your repositories.

If you have any questions or need assistance, please do not hesitate to contact us. We’re always here to help!