This repository has been archived on 2024-09-20. You can view files and clone it, but cannot push or open issues or pull requests.
docker-run-action/README.md
Abdud Dayan Adeeb 32e3e5ab6a
Update README.md
2020-06-19 20:36:37 -04:00

1.4 KiB

Docker Run Action

Github Workflows already supports running on public docker images out-of-the-box (See jobs.<jobs_id>.container).

Why use docker-run-action?

  • run on a privately-owned image.
  • run on an image built by a previous step.
  • run a specific step in docker

Example Usage

single-line command

- uses: addnab/docker-run-action@v1
  with:
    image: docker:latest
    run: echo "hello world"

multi-line commands

- uses: addnab/docker-run-action@v1
  with:
    image: docker:latest
    run: |
      echo "first line"
      echo "second line"      

run on a privately-owned image

- uses: addnab/docker-run-action@v1
  with:
    username: ${{ secrets.DOCKER_USERNAME }}
    password: ${{ secrets.DOCKER_PASSWORD }}
    registry: gcr.io
    image: test-image:latest
    run: echo "hello world"

run on an image built by a previous step

- uses: docker/build-push-action@v1
  with:
    repository: test-image
    push: false
- uses: addnab/docker-run-action@v1
  with:
    image: test-image:latest
    run: echo "hello world"

use a specific shell (default: sh).

Note: The shell must be installed in the container

- uses: addnab/docker-run-action@v1
  with:
    image: docker:latest
    shell: bash
    run: |
      echo "first line"
      echo "second line"