actions-marketplace-validations/Dev Container Build and Run Action

Action to simplify using Dev Containers (https://containers.dev) in GitHub workflows

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
imageNameImage name (including registry)no
imageTagOne or more comma-separated image tags (defaults to latest)no
platformPlatforms for which the image should be built. If omitted, defaults to the platform of the GitHub Actions Runner. Multiple platforms should be comma separated.
runCmdSpecify the command to run after building the dev container image. Can be omitted to skip starting the container.no
subFolderSpecify a child folder (containing a .devcontainer) instead of using the repository rootno
configFileSpecify the path to a devcontainer.json file instead of using `./.devcontainer/devcontainer.json` or `./.devcontainer.json`no
checkoutPathSpecify path to checked out folder if not using default (or for testing with nektos/act)no.
pushControl when images are pushed. Options are never, filter, always. For filter (default), images are pushed if the refFilterForPush and eventFilterForPush conditions are metnofilter
refFilterForPushSet the source branches (e.g. refs/heads/main) that are allowed to trigger a push of the dev container image. Leave empty to allow all.no
eventFilterForPushSet the event names (e.g. pull_request, push) that are allowed to trigger a push of the dev container image. Defaults to push. Leave empty for allnopush
envSpecify environment variables to pass to the docker run commandno
inheritEnvInherit all environment variables of the runner CI machine.nofalse
skipContainerUserIdUpdateFor non-root Dev Containers (i.e. where `remoteUser` is specified), the action attempts to make the container user UID and GID match those of the host user. Set this to true to skip this step (defaults to false)nofalse
userDataFolderSome steps for building the dev container (e.g. container-features) require generating additional build files. To aid docker build cache re-use, you can use this property to set the path that these files will be generated under and use the actions/cache action to cache that folder across runsno
cacheFromSpecify additional images to use for build cachingno
noCacheBuilds the image with `--no-cache` (takes precedence over `cacheFrom`)nofalse
cacheToSpecify the image to cache the built image tono
namedescription
runCmdOutputThe output of the command specified in the runCmd input