This article is about CodeShip Pro.

Setting Up Or Migrating A Project To CodeShip Pro

You will need roughly 3 minutes to read this article.

Setting Up A New Project

Once you have your project running locally you can configure the repository on CodeShip and have the builds run on each push.

If you already worked with CodeShip the process will be familiar (and if not, it should be very simple nonetheless).

  1. Click on the Select Project dropdown in the top bar and select the Create a new project button.

  2. Select the repository provider you want to host your repositories with.

  3. Select the repository you want to build on CodeShip. You can filter the list via the search form. (If a repository belonging to an organization on GitHub isn’t listed, please take a look at 3rd party restrictions.)

So far these are the standard steps to add a new project on CodeShip.

  1. You can now choose between CodeShip Basic (hosted) and CodeShip Pro (Docker). Choose the latter. Select CodeShip Pro

  2. You will be presented with a screen offering basic setup instructions, as well as a link to the documentation for CodeShip Pro. Docker Project Help Screen

    As we already added all the required information to the repository, you can simply push a new commit and this will trigger a new build on CodeShip.

  3. Once you trigger a (couple) new builds, you’ll see the standard CodeShip build listing page. Build Listing

  4. Clicking on a single build takes you to the build details. Build Details

    The page is split in two panes. On the left hand side you will find basic build details, including the commit message, who triggered the build and which branch (or tag) triggered the build.

    You will also see the services defined in your codeship-services.yml file (if you click on the Services header as this section is hidden by default).

    The main portion of the left pane is dedicated to listing the steps you have defined. Clicking on a single step will open the step log in the right pane. Each step includes the following information:

    • the command you are running
    • the service the step is running on (on the right hand side)
    • the status indicated by an icon
  5. The remaining project configuration (e.g. team management or notifications) is identical to a standard CodeShip project and accessible via the Project Settings dropdown at the top.

Migrating From Basic To Pro

Create A New Pro Project

To create a new CodeShip Pro project, just select the Pro infrastructure after connecting your source control.

Selecting CodeShip Pro

You can learn more about creating a new project here..

Switch A Basic Project To A Pro Project

To switch a project from CodeShip Basic to CodeShip Pro, just click on “Project Settings” in the top right. Then, under the “General” tab, you will see a “Switch project to CodeShip Pro” button.

Selecting CodeShip Pro

Run Pro Builds On Basic Projects

On any CodeShip Basic project, you can commit to the branch codeship-docker-migration to trigger a CodeShip Pro build. You will still need the configuration files in your repository which include codeship-services.yml and codeship-steps.yml. You can use our command-line tool, Jet, to work on the setup for your project. Note that this is the only branch that will run Pro builds on Basic projects, and these builds will show up in your build queue. After you trigger your first CodeShip Pro build, your project will create an AES key in your general project settings which can be used to encrypt environment variables. Before starting this migration, we recommend going through our getting started guide.

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!