This article is about General Codeship Configuration.

Signing Up For A New Account

You will need roughly 6 minutes to read this article.

Setting Up A New CodeShip Account

If you’re looking to sign up and create a project on CodeShip, this guide will walk you through the initial onboarding process.

Signing up for CodeShip with GitHub, Bitbucket or GitLab

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.

  1. Navigate to our signup page.

  2. Select either GitHub, Bitbucket or GitLab.

SCM Choice

  • If GitHub: You are automatically directed to a login page where you must enter your GitHub login credentials in order to give CodeShip access to your account.

GitHub Login

  • If Bitbucket: You are automatically directed to a login page where you must enter your Bitbucket login credentials in order to give CodeShip access to your account.

Bitbucket Login

  • If GitLab: You are automatically directed to a login page where you must enter your GitLab login credentials in order to give CodeShip access to your account.

GitLab Login

Signing up for CodeShip with an e-mail address

To sign up for CodeShip with an email:

  1. Enter your name, email address, and create a password.

  2. Click the Sign Up for Free button.

Email Login

You can learn more about the permissions required when authenticating with your SCM here. Learn more about security at CodeShip here.

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.

Creating your organization account

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: app.codeship.com/<your-organization-name>.

To create your organization account:

  1. Enter a unique organization name.

  2. Click Create Organization.

Account Creation Page

or

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.

Creating your first project

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:

  1. Select either GitHub, Bitbucket, or GitLab. If you signed up for CodeShip with your SCM, you can skip this step.

  2. 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:

     git@github.com:<username>/<repository_name>.git
     https://github.com/<username>/<repository_name>.git
    
  3. Click the Connect button.

    Note that a repository can only be connected to one CodeShip project.

  4. Either select Select Pro Project or Select Basic Project. You can choose to set up your project with CodeShip Basic or CodeShip Pro.

    Basic is a good place to start if:

    • You want out of the box configuration.
    • You can use common, pre-installed CI dependencies.
    • You prefer easy, 1-click deployment integrations.

    Pro is a good place to start if:

    • You want Docker support.
    • You want a fully customizable CI environment.
    • You want a local build runner for test consistency.

Customizing your project

Adding team members to your projects

To add team members to your project:

  1. Select the Teams tab in the dashboard.

  2. Click the New Team button.

  3. 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.

Adding status badges to your repository

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.

CodeShip Status for codeship/documentation

The raw URL for the image looks like this:

https://app.codeship.com/projects/YOUR_PROJECT_UUID/status?branch=master

Additional information

Configuring your avatar

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.

Keyboard shortcuts

To make it easier to navigate through your CodeShip projects, we’ve provided several keyboard shortcuts for quickly jumping through the interface:

  • Shift + ? brings up a list of all shortcuts
  • gp, available from inside your projects, will return you to your projects overview page
  • Escape key, available on your projects overview page, will return you to the previous page
  • Arrow keys, available on your projects overview page, will navigate between your projects
  • Enter key, available on your projects overview page, will select the highlighted project
  • s focuses on the project search bar
  • gd returns you to the CodeShip homepage

Need more help?

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.

Article not helpful?

Does this article need improvement? If so, please send feedback or submit a pull request!