Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/actionify/src/actions/types.ts>RunsDocker

Create and manage your GitHub workflows with TypeScript and Deno.
Latest
interface RunsDocker
import { type RunsDocker } from "https://deno.land/x/actionify@0.3.0/src/actions/types.ts";

Configures the image used for the Docker action.

Properties

using: "docker"

You must set this value to 'docker'.

image: string

The Docker image to use as the container to run the action. The value can be the Docker base image name, a local Dockerfile in your repository, or a public image in Docker Hub or another registry. To reference a Dockerfile local to your repository, use a path relative to your action metadata file. The docker application will execute this file.

optional
env: { [k: string]: string; }

Specifies a key/value map of environment variables to set in the container environment.

optional
entrypoint: string

Overrides the Docker ENTRYPOINT in the Dockerfile, or sets it if one wasn't already specified. Use entrypoint when the Dockerfile does not specify an ENTRYPOINT or you want to override the ENTRYPOINT instruction. If you omit entrypoint, the commands you specify in the Docker ENTRYPOINT instruction will execute. The Docker ENTRYPOINT instruction has a *shell* form and *exec* form. The Docker ENTRYPOINTdocumentation recommends using the *exec* form of theENTRYPOINT` instruction.

optional
pre-entrypoint: string

Allows you to run a script before the entrypoint action begins. For example, you can use pre-entrypoint: to run a prerequisite setup script. GitHub Actions uses docker run to launch this action, and runs the script inside a new container that uses the same base image. This means that the runtime state is different from the main entrypoint container, and any states you require must be accessed in either the workspace, HOME, or as a STATE_ variable. The pre-entrypoint: action always runs by default but you can override this using pre-if.

optional
pre-if: PreIf
optional
post-entrypoint: string

Allows you to run a cleanup script once the runs.entrypoint action has completed. GitHub Actions uses docker run to launch this action. Because GitHub Actions runs the script inside a new container using the same base image, the runtime state is different from the main entrypoint container. You can access any state you need in either the workspace, HOME, or as a STATE_ variable. The post-entrypoint: action always runs by default but you can override this using post-if.

optional
post-if: PostIf
optional
args: string[]

An array of strings that define the inputs for a Docker container. Inputs can include hardcoded strings. GitHub passes the args to the container's ENTRYPOINT when the container starts up. The args are used in place of the CMD instruction in a Dockerfile. If you use CMD in your Dockerfile, use the guidelines ordered by preference:

  • Document required arguments in the action's README and omit them from the CMD instruction.
  • Use defaults that allow using the action without specifying any args.
  • If the action exposes a --help flag, or something similar, use that to make your action self-documenting.