You will need roughly 6 minutes to read this article.
If you’re looking to sign up and create a project on CodeShip, this guide will walk you through the initial onboarding process.
You can sign up for a new CodeShip account either with your source code management (SCM) system or email address. The following SCMs are supported: GitHub, Bitbucket or GitLab.
To signup with your SCM:
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.
Select either GitHub, Bitbucket or GitLab.
To sign up for CodeShip with an email:
Enter your name, email address, and create a password.
Click the Sign Up for Free button.
Note: When signing up using your email, we won’t know what your git username is, which means that your personal dashboard won’t be populated with your builds. To get your builds to show up, visit the Connected Services page and connect your accounts there.
Once you’ve signed up, unless you were invited by a team member to an existing organization, you will be asked to create a new organization. Organization names must be unique since, you will be able to access your account with a unique URL. The unique URL is:
To create your organization account:
Enter a unique organization name.
Click Create Organization.
Ask your team to invite you to an existing organization with your e-mail.
In case you are expecting to be invited to an already existing organization, you will find the email you signed up with - sometimes less obvious for oAuth signup - on the organization creation page.
Right after account creation, you can either create your first project right away or begin setting up your teams and inviting your colleagues.
To create your first project:
Select either GitHub, Bitbucket, or GitLab. If you signed up for CodeShip with your SCM, you can skip this step.
Enter your git clone URL. You can find the correct clone command in the header of the repository under Clone.
The following are examples of git clone URLs:
Click the Connect button.
Note that a repository can only be connected to one CodeShip project.
Basic is a good place to start if:
Pro is a good place to start if:
To add team members to your project:
Select the Teams tab in the dashboard.
Click the New Team button.
Enter the team name and select the team role.
We recommend inviting people to the Managers team if they will need to create or delete projects or manage additional team members. See team roles and permissions for more information.
If you want to add a badge to your README showing your last build’s status, you can find the code under Project Settings > General.
The raw URL for the image looks like this:
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 account settings as well as for any email addresses you use in your git configuration.
You can check the latter by running the following command on your local git repository:
# 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 SCM 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:
?brings up a list of all shortcuts
gp, available from inside your projects, will return you to your projects overview page
sfocuses on the project search bar
gdreturns you to the CodeShip homepage
Contact our support team or post on Stack Overflow using the tag
#codeship. Did you check the status page and changelog?
There are also several code examples and sample projects available for you to get started with.