This article is about Codeship Basic.

Deploy With Custom Scripts

You will need roughly 2 minutes to read this article.

Using A Custom Script

A custom script deployment is useful if your deployment requires additional or custom commands that are not available with some of Codeship’s integrated deployment options.

A custom script deployment is also useful when you need to execute another task after or prior to a deployment. For example:

# Execute rake tasks
bundle exec rake my_rake_task

# Run additional tests
# my_test_script.sh lives in the root folder
./my_test_script.sh

# Deploy to Amazon S3 or any other server with ssh access
# You can define your keys with environment variables

When using a single test pipeline, the same build container is used for the entire build and deploy so any configuration done during the setup and testing phase will also be present for the deployment phase. When using multiple test pipelines, a new container is used for the deploy and setup commands do not run again. If your deployment has any specific dependencies you will want to include those commands with your deployment steps.

Please follow these steps to create a custom deployment script:

Step 1

Navigate to your project’s deployment configuration page by selecting Project Settings > Deployment on the top right side of the page.

Project Settings Deployment

Step 2

Edit an existing deployment pipeline or create a new deployment pipeline by selecting + Add new deployment pipeline. Create the deployment pipeline to match the exact name of your deployment branch or a wildcard branch.

Create branch deploy

Step 3

Select Custom Script

Select Custom Script

Step 4

Insert your deployment commands in the Deployment Commands box shown below. Then click Create Deployment to save your custom deployment script.

Create Custom Script

Success!

Custome Deployment Success

You have now successfully created a custom deployment script. Go ahead and push a commit to your configured deploy branch.

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!