scripts's Introduction

Codeship Scripts

A public collection of useful scripts for use on Codeship and similar tools.

E.g. scripts to install specific versions of software not included by default on the build VMs. Deployment scripts for external services to customize to your needs, configure caching or trigger notifications. And other scripts if you want to have them included ;)

Using the scripts

Each script includes a comment at the beginning detailing how to configure and use the script in your builds. Those comments look for example like

# Add at least the following environment variables to your project configuration
# (otherwise the defaults below will be used).
# * FIREFOX_VERSION
#
# Include in your builds via
# \curl -sSL https://raw.githubusercontent.com/codeship/scripts/master/packages/firefox.sh | bash -s

It is important that you follow those instructions and not simply copy / paste the scripts into your Codeship project configuration.

Most scripts include set -e to make the script fail as soon as a subcommand returns a non-zero exit code (which indicates failure).

This is fine if you call the script as documented above (via the curl command). But it will have side effects if you copy the commands into your settings on codeship.com as any command that fails after the set -e) will terminate your build. You'll get a SYSTEM build status, but no further error message or log output. You probably don't want this :)

Please see the post at https://documentation.codeship.com/basic/builds-and-configuration/scripts/#set--e for more information on how set -e works and why this causes issues if you include it in your setup or test commands.