Skip to content
arrow-right-circle

GitHub Action

Command Docker GitHub Action

v1.3.0 Latest version

Command Docker GitHub Action

arrow-right-circle

Command Docker GitHub Action

A simple GitHub Action for running a shell command via a Docker container

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Command Docker GitHub Action

              
  uses: cliffano/command-docker-action@v1.3.0
Learn more about this action in cliffano/command-docker-action

Choose a version

Avatar

Build Status Security Status

Command Docker GitHub Action

A simple GitHub Action for running a shell command via a Docker container.

The command will be executed on a directory containing the GitHub repository content.

Usage

Run commands across Docker containers with different images and shells:

jobs:
  build:
    steps:
      - name: 'Execute cat /etc/*-release using default sh shell via default alpine Docker container'
        uses: cliffano/command-docker-action@main
        with:
          command: 'cat /etc/*-release'
      - name: 'Execute cat /etc/*-release using bash shell via Ubuntu 22.04 Docker container'
        uses: cliffano/command-docker-action@main
        with:
          command: 'cat /etc/*-release'
          image: ubuntu:22.04
          shell: bash
      - name: 'Execute cat /etc/*-release using bash shell via Rocky Linux 9.3 Docker container'
        uses: cliffano/command-docker-action@main
        with:
          command: 'cat /etc/*-release'
          image: rockylinux:9.3
          shell: bash

Run command using environment variables passed via env file:

jobs:
  build:
    steps:
      - uses: iamsauravsharma/create-dotenv@v2.0.1
        with:
          file-path: '/tmp/.env'
        env:
          SOME_ENV_VAR: 'Some value'
      - name: 'Display environment variables'
        uses: cliffano/command-docker-action@main
        with:
          command: 'echo "SOME_ENV_VAR: $SOME_ENV_VAR"'
          env_file: '/tmp/.env'

Run command with extra PATH environment variable:

jobs:
  build:
    steps:
      - name: 'Run custom command from a custom path specified in extra_path'
        uses: cliffano/command-docker-action@main
        with:
          command: 'mkdir -p /opt/workspace/bin/ && touch /opt/workspace/bin/some-exec && chmod +x /opt/workspace/bin/some-exec && which some-exec'
          extra_path: '/some/path:/opt/workspace/bin'

Configuration

Input Type Description Required Default Example
command string Shell command to be executed via a Docker container Yes - cat /etc/*-release
image string Docker image to be used for running the container No alpine:3.20 ubuntu:22.04
extra_path string Extra PATH environment variable to be added to original PATH during shell command execution No `` /some/path:/opt/workspace/bin
shell string Shell to be used for running the command No sh sh, bash
env_file string Path to env file containing environment variables made available during shell command execution No `` /tmp/.env