Schema for codeship-steps.yml files. Json Format - LivMatter

Your Apps in Action

Use this form to visualize Schema for codeship-steps.yml files..

{{repoTitle.MainEntity}}

name - The name of the step. Can be omitted.

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

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

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

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

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

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

image_tag - 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

registry - 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 - The location of a Docker configuration file encrypted by Jet to be used with this step. Optional.

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

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

#	Values	Actions
{{$index+1}}.

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

#	name	type	tag	exclude	service	command	image_name	image_tag	registry	encrypted_dockercfg_path	Actions
{{$index+1}}.	{{row.name}}	{{row.type}}	{{row.tag}}	{{row.exclude}}	{{row.service}}	{{row.command}}	{{row.image_name}}	{{row.image_tag}}	{{row.registry}}	{{row.encrypted_dockercfg_path}}

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

#	name	type	tag	exclude	service	command	image_name	image_tag	registry	encrypted_dockercfg_path	Actions
{{$index+1}}.	{{row.name}}	{{row.type}}	{{row.tag}}	{{row.exclude}}	{{row.service}}	{{row.command}}	{{row.image_name}}	{{row.image_tag}}	{{row.registry}}	{{row.encrypted_dockercfg_path}}

{{repoTitle.MainEntity}}

name - The name of the step. Can be omitted.

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

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

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

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

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

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

image_tag - 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

registry - 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 - The location of a Docker configuration file encrypted by Jet to be used with this step. Optional.

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

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

#	Values	Actions
{{$index+1}}.

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

#	name	type	tag	exclude	service	command	image_name	image_tag	registry	encrypted_dockercfg_path	Actions
{{$index+1}}.	{{row.name}}	{{row.type}}	{{row.tag}}	{{row.exclude}}	{{row.service}}	{{row.command}}	{{row.image_name}}	{{row.image_tag}}	{{row.registry}}	{{row.encrypted_dockercfg_path}}

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

#	name	type	tag	exclude	service	command	image_name	image_tag	registry	encrypted_dockercfg_path	Actions
{{$index+1}}.	{{row.name}}	{{row.type}}	{{row.tag}}	{{row.exclude}}	{{row.service}}	{{row.command}}	{{row.image_name}}	{{row.image_tag}}	{{row.registry}}	{{row.encrypted_dockercfg_path}}

{{repoTitle.MainEntity}}

name - The name of the step. Can be omitted.

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

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

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

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

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

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

image_tag - 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

registry - 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 - The location of a Docker configuration file encrypted by Jet to be used with this step. Optional.

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

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

#	Values	Actions
{{$index+1}}.

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

#	name	type	tag	exclude	service	command	image_name	image_tag	registry	encrypted_dockercfg_path	Actions
{{$index+1}}.	{{row.name}}	{{row.type}}	{{row.tag}}	{{row.exclude}}	{{row.service}}	{{row.command}}	{{row.image_name}}	{{row.image_tag}}	{{row.registry}}	{{row.encrypted_dockercfg_path}}

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

#	name	type	tag	exclude	service	command	image_name	image_tag	registry	encrypted_dockercfg_path	Actions
{{$index+1}}.	{{row.name}}	{{row.type}}	{{row.tag}}	{{row.exclude}}	{{row.service}}	{{row.command}}	{{row.image_name}}	{{row.image_tag}}	{{row.registry}}	{{row.encrypted_dockercfg_path}}

{{message}}