CodeShip Pro steps configuration files

codeship-steps.yml files

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

Validate with Lintel

npx @lintel/lintel check
Type: ExternalStep[]

codeship-steps.yml is where you configure each step to run in your CI/CD builds with CodeShip.

Items

object

The definition of a step

name string

The name of the step. Can be omitted.

type string

The type of the step. If omitted, defaults to 'run'

Values: null "run" "serial" "push" "parallel" "load" "manual"
tag string

A pattern matching tags or branches this step and any of its children should be run against. Defaults to always running.

exclude string

A pattern matching tags or branches on which this step should NOT be run. Defaults to empty.

service string

The service name defined in codeship-services.yml this step will run on

services string[]

A list of service names defined in codeship-services.yml that will be used for this step.

command string

The command to be run in this step. Required with and can only be used with the 'run' type or no specified type

steps ExternalStep[]

A list of steps to run within this step or on_fail group. Cannot be used with 'run', 'push', or 'load' steps

image_name string

The image name this push step should push to. Required with and only used by the push step

image_tag string

The image tag this push step should push to. See https://docs.cloudbees.com/docs/cloudbees-codeship/latest/pro-builds-and-configuration/steps#_push_steps for details. Only used by the push step

Default: "latest"
registry string

The image registry this push step should push to. For Docker Hub, use https://registry-1.docker.io. Required with and only used by the push step

encrypted_dockercfg_path string

The location of a Docker configuration file encrypted by Jet to be used with this step. Optional.

dockercfg_service string

The name of a service defined in codeship-services.yml that provides the Docker configuration. Optional.

on_fail ExternalStep[]

An optional list of steps to run if this step fails.

Definitions

ExternalStep object

The definition of a step

name string

The name of the step. Can be omitted.

type string

The type of the step. If omitted, defaults to 'run'

Values: null "run" "serial" "push" "parallel" "load" "manual"
tag string

A pattern matching tags or branches this step and any of its children should be run against. Defaults to always running.

exclude string

A pattern matching tags or branches on which this step should NOT be run. Defaults to empty.

service string

The service name defined in codeship-services.yml this step will run on

services string[]

A list of service names defined in codeship-services.yml that will be used for this step.

command string

The command to be run in this step. Required with and can only be used with the 'run' type or no specified type

steps ExternalStep[]

A list of steps to run within this step or on_fail group. Cannot be used with 'run', 'push', or 'load' steps

image_name string

The image name this push step should push to. Required with and only used by the push step

image_tag string

The image tag this push step should push to. See https://docs.cloudbees.com/docs/cloudbees-codeship/latest/pro-builds-and-configuration/steps#_push_steps for details. Only used by the push step

Default: "latest"
registry string

The image registry this push step should push to. For Docker Hub, use https://registry-1.docker.io. Required with and only used by the push step

encrypted_dockercfg_path string

The location of a Docker configuration file encrypted by Jet to be used with this step. Optional.

dockercfg_service string

The name of a service defined in codeship-services.yml that provides the Docker configuration. Optional.

on_fail ExternalStep[]

An optional list of steps to run if this step fails.