Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
anchor

GitHub Action

Publish Docker

2.6

Publish Docker

anchor

Publish Docker

Uses the git branch as the docker tag and pushes the container

Installation

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

              

- name: Publish Docker

uses: elgohr/Publish-Docker-Github-Action@2.6

Learn more about this action in elgohr/Publish-Docker-Github-Action

Choose a version

Publishes docker containers

Actions Status Actions Status Actions Status

This Action for Docker uses the Git branch as the Docker tag for building and pushing the container. Hereby the master-branch is published as the latest-tag.

Usage

Example pipeline

name: Publish Docker
on: [push]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: Publish to Registry
      uses: elgohr/Publish-Docker-Github-Action@master
      with:
        name: myDocker/repository
        username: ${{ secrets.DOCKER_USERNAME }}
        password: ${{ secrets.DOCKER_PASSWORD }}

Mandatory Arguments

name is the name of the image you would like to push
username the login username for the registry
password the login password for the registry

If you would like to publish the image to AWS ECR, please have a look at https://github.com/elgohr/ecr-login-action

Outputs

tag is the tag, which was pushed
snapshot-tag is the tag that is generated by the snapshot-option and pushed

Optional Arguments

registry

Use registry for pushing to a custom registry

with:
  name: myDocker/repository
  username: ${{ secrets.DOCKER_USERNAME }}
  password: ${{ secrets.DOCKER_PASSWORD }}
  registry: docker.pkg.github.com

snapshot

Use snapshot to push an additional image, which is tagged with
{YEAR}{MONTH}{DAY}{HOUR}{MINUTE}{SECOND}{first 6 digits of the git sha}.
The date was inserted to prevent new builds with external dependencies override older builds with the same sha. When you would like to think about versioning images, this might be useful.

with:
  name: myDocker/repository
  username: ${{ secrets.DOCKER_USERNAME }}
  password: ${{ secrets.DOCKER_PASSWORD }}
  snapshot: true

dockerfile

Use dockerfile when you would like to explicitly build a Dockerfile.
This might be useful when you have multiple DockerImages.

with:
  name: myDocker/repository
  username: ${{ secrets.DOCKER_USERNAME }}
  password: ${{ secrets.DOCKER_PASSWORD }}
  dockerfile: MyDockerFileName

workdir

Use workdir when you would like to change the directory for building.

with:
  name: myDocker/repository
  username: ${{ secrets.DOCKER_USERNAME }}
  password: ${{ secrets.DOCKER_PASSWORD }}
  workdir: mySubDirectory

buildargs

Use buildargs when you want to pass a list of environment variables as build-args. Identifiers are separated by comma.
All buildargs will be masked, so that they don't appear in the logs.

- name: Publish to Registry
  uses: elgohr/Publish-Docker-Github-Action@master
  env:
    MY_FIRST: variableContent
    MY_SECOND: variableContent
  with:
    name: myDocker/repository
    username: ${{ secrets.DOCKER_USERNAME }}
    password: ${{ secrets.DOCKER_PASSWORD }}
    buildargs: MY_FIRST,MY_SECOND

cache

Use cache when you have big images, that you would only like to build partially (changed layers).

CAUTION: This will cache the non changed parts forever. If you use this option, make sure that these parts will be updated by another job!

with:
  name: myDocker/repository
  username: ${{ secrets.DOCKER_USERNAME }}
  password: ${{ secrets.DOCKER_PASSWORD }}
  cache: true