StepOptions | /lib.ts | cicada@v0.1.50

interface StepOptions

import { type StepOptions } from "https://deno.land/x/cicada@v0.1.50/lib.ts";

The options available in a step such as the name, the script to run, what directories to cache, and the secrets/env variables needed.

Properties

run: string | string[] | StepFn

The command to run as a string or a step function.

optional

name: string

The name of the step.

optional

cacheDirectories: CacheDirectories

Cache directories are mounted as docker volumes. You may use absolute or relative paths. They are mounted for this job only. Use cacheDirectories in a Job for caching at the Job level.

optional

ignoreCache: boolean

Disable caching for this step. This will cause the step to run every time and may cause subsequent steps to run every time as well.

optional

env: Record<string, string>

Environment variables to set specifically for this step

optional

secrets: Secret[]

Secrets to expose specifically for this step. Secrets are accessible in the run function via secret.value() or via the /run/secrets directory.

Use secrets rather than env for greater security in job runs and caching.

optional

workingDirectory: FilePath

The directory where the step should run.

optional

shell: Shell

The shell to use for running the command. This can be bash, sh, or ShellOptions.