Configuring CloudBees CodeShip and GitHub

2 minute read

Before you connect your GitHub repository to your CloudBees CodeShip account, you’ll need to make sure that the proper permissions and access have been granted.


If you are setting up a new project, then you will first need to install the CodeShip GitHub app on your GitHub organization. This app will be used to access your repositories. Once the app is installed, make sure that it has access to the repository that you want to use in your project.

The CodeShip GitHub app will ask for the following permissions:

  • Read your code

  • Read your GitHub organization metadata (this is a default behavior managed by GitHub)

  • Read and write access to administer your project and set commit status (this is necessary to update the commit status)

The default permissions allow us to see what resources you have access to (like which organizations you’re connected to, and if they have the CodeShip app installed). These permission requirements are managed by GitHub and therefore we can’t reduce the level of access required for CodeShip to operate properly.

Connecting a repository

  • Sign into CloudBees CodeShip - you can authenticate using your email address or SCM credentials

  • Click on Projects and then select GitHub when prompted to select your SCM

  • Sign into GitHub when prompted and grant access to CloudBees CodeShip

  • Select your GitHub organization and repository from the dropdown menus

  • Don’t see your organization? Make sure you have installed the CodeShip GitHub app

  • Select your project type (CloudBees CodeShip Pro or CloudBees CodeShip Basic) and create your project

  • When you are finished, save your project at the bottom of the page and go to the dashboard