CodeShip Pro services configuration files

codeship-services.yml files

Type object
File match codeship-services.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/codeship-pro-services-configuration-files/latest.json
Source https://www.schemastore.org/codeship-services.json

Validate with Lintel

npx @lintel/lintel check
Type: object

codeship-services.yml is where you configure each service you need to run your CI/CD builds with CodeShip.

Definitions

ExternalService object

The definition of a service in a CodeShip Pro build, which can have steps run on it or have other services depend on it

add_docker boolean

If true, the docker socket will be exposed in this service.

Default: false
build externalBuild | string

How to build the image for this service. Mutually exclusive with 'image'. Can either be just a path containing a Dockerfile, or a build definition.

cached boolean

Whether the image for this service should be rebuilt from scratch for each run, or if the latest build of the service's image from the configured cache branch (defaulting to 'master') should be used.

Default: false
cap_add string[]
cap_drop string[]
command string

The command to run when launching the service, overriding the 'CMD' in the image. Optional.

cpuset string
cpu_shares integer
default_cache_branch string

The branch to use for caching. Defaults to 'master'

dns string[]
dns_search string[]
dockercfg_service string

The name of another defined service that provides the Docker configuration for building and running this service. Optional.

dockerfile string

A specific Dockerfile to use, rather than the one in the build context

domainname string
encrypted_dockercfg_path string

The location of a Docker configuration file encrypted by Jet to be used with building and running this service. Optional.

encrypted_env_file string[] | string

The location of one or more files, encrypted with Jet, containing environment variables to be made available to this service and steps running on it. Optional.

encrypted_environment string[]

A list of encrypted key/value pairs to be used in the environment for this service and steps running on it. Optional.

entrypoint string[] | string
env_file string[] | string

The location of one or more files containing environment variables to be made available to this service and steps running on it. Optional.

environment string[] | object

Either a map of key/value pairs or a list of 'KEY=VALUE' pairs to be used in the environment for this service and steps running on it. Optional.

expose string[]
extra_hosts string[]
hostname string
image string

A pre-existing image to use for this service. Mutually exclusive with 'build'

links string[]
depends_on string[]

A list of other services that this service depends on. Use this instead of 'links'

mem_limit string
privileged boolean
ports string[]

A list of ports that should be exposed to other services. The ports should be defined like '9999', as strings

read_only boolean
restart string
security_opt string[]
user string
volumes string[]

A list of origin/destination pairs of directories or files relative to the build context and where they should be mounted in the service. Optional.

volumes_from string[]

A list of other services which should have their defined volumes mounted into this service as well. Optional.

working_dir string
externalBuild object

Configuration of how to build the image for this service

path string

DEPRECATED: Use 'context' instead.

dockerfile_path string

DEPRECATED: Use 'dockerfile' instead

image string

The output image name for this image. Optional.

context string

The directory used as the Docker build context. Defaults to the same directory as the codeship-services.yml file

dockerfile string

A specific Dockerfile to use rather than the 'Dockerfile' present in the build context. Optional.

configure object
2 nested properties
service string
command string
args string[] | object

Build args to pass to Docker. Optional.

encrypted_args_file string[] | string

One or more files, encrypted with Jet, to have their contents decrypted and passed to Docker as build args. Optional.

encrypted_args string[] | string

A list of encrypted key/value pairs to be used as build args to Docker. Optional.

externalBuildConfigure object
service string
command string