Collaborate in GitHub

Use a GitHub repository to collaborate with team members.

Part 6 Of A Series

This is part 6 of a guide that walks through creating a sample application in Replicated Ship. If you haven’t followed the previous sections of this guide, go back to iterating locally before following this guide.

With the recommended repository layout set up, the next step is to link your Ship spec in to the ship.yaml file in your git repository.

Authorizing GitHub Access

GitHub only (for now)

This guide relies on GitHub-only Ship packaging features. The vendor tooling for Ship applications will eventually support other Git providers like GitLab and BitBucket, but for now this guide requires that your ship.yaml is stored in GitHub.

From, head over to “Account Settings”:

Console Account Settings

From here, you’ll want to select “Connect to GitHub” to authorize Replicated to access one or more GitHub repositories.

Console Link GitHub

Then, you can select the repository in which you’re storing your ship.yaml and Kubernetes manifests.

Github Auth Repo

When you are done on GitHub, you should be taken back to the Ship Console, at which point we can link your channels to GitHub branches. Select “Edit Release” on your Nightly channel, then click “Use Github to manage releases for this channel.”

View Release

Use Github

From here, you can configure the branch you want to use for the Nightly channel. There are a few options here, but in general we see the master branch used for Nightly, with separate beta or release branches used for the other release channels.

That’s it! You’re now set up for using GitHub as the single source of truth for your Ship application.

Next Steps

Now that you’ve got a feel for Ship basics, its time to take a deep dive into Ship features.