Estimated Reading Time: 5 mins
If you’re looking to sign up and create a project on Codeship, this guide will walk you through the initial onboarding process.
Sign up Navigate to our signup page. You can sign up either via your Source Code Management (SCM) or email address. SCMs we currently support are: GitLab, Bitbucket, or GitHub.
Note that these oAuth login pages come directly from the SCM tools themselves and we do not have access to them or to the credentials you provide.
Once you’ve signed-up for Codeship you’ll be directed to a short form where we ask a few questions about your team size and type of product you’re looking for. We ask these questions so that we can get a better sense of what you’d like to achieve with Codeship and so that we can direct you to the correct resources/help.
Authenticate SCM: If you signed up for Codeship via GitLab, Bitbucket, or Github, your SCM is already authenticated! If you’ve signed up via email, you authenticate your SCM here:
Simply click on the SCM icon you would like to connect with and proceed to provide your login credentials in order to give Codeship access to your account (see step 1 for further information).
Choose your repository: Once you have authenticated your SCM you have to select your repository. To choose your repository, simply paste your Git clone URL into the provided area and click ‘Connect’.
Now that you’ve connected your repo, it’s time to select your infrastructure! You simply have to decide if you want to set up your project with Codeship’s Basic Infrastructure. or Codeship’s Pro Infrastructure.
Basic is a good place to start if:
Pro is a good place to start if:
Once you know which type of infrastructure you’d like to use, simply click ‘Select Infrastructure’ on the corresponding project.
There are no plans to integrate with other SCM tools like Subversion.
If you want to add a badge showing your last builds status to your ReadMe, you can find the code in the Notification settings of your project.
The raw URL for the image looks like the this:
The UUID for a specific project is available on the General tab in your project settings.
Git identifies people by your e-mail and Codeship uses your Gravatar settings for your profile picture. If you have not set up Gravatar yet and want to change the avatar shown on Codeship and in your commit messages, please head over to Gravatar.com and setup an avatar for both the email address you configured in your Codeship Account Settings as well as for any email addresses you use in your git configuration.
You can check the latter via running the following command in your local git checkout.
# global configuration git config --global --get user.email # project specific (local) configuration git config --get user.email
Note that different projects can have different email addresses configured and that your VCS can have other email addresses configured for the actions you take via their interfaces.
To make it easier to navigate through your Codeship projects, we’ve provided several keyboard shortcuts for quickly jumping through the interface:
gp, available from inside your projects, will return you to your projects overview page
We also have a couple of code examples and sample projects available, that make it easier to get started with Codeship.