Skip to content
tag

GitHub Action

Generate smart tag for Docker images

v1.0.3 Latest version

Generate smart tag for Docker images

tag

Generate smart tag for Docker images

Generate Docker tag from for each branches or tags

Installation

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

              
- name: Generate smart tag for Docker images

              
  uses: Surgo/docker-smart-tag-action@v1.0.3
Learn more about this action in Surgo/docker-smart-tag-action

Choose a version

Create a JavaScript Action using TypeScript

build-test License: MIT

About

Generate Docker tag from for each branches or tags

💡 See also:

Example (smart) tag

  • Pull request: pr-<pull request number>
  • Publish with tags: v1.0.0 => 1.0.0, 1.0, 1 and latest
  • Branch: topic/my_branch => topic-my_branch
    • Default branch => edge
    • Scheduled build => nightly

Usage

jobs:
  main:
    runs-on: ubuntu-latest
  steps:
    - name: Get smart tag
      id: prepare
      uses: Surgo/docker-smart-tag-action@v1
      with:
        docker_image: name/app
    - name: Build and push
      uses: docker/build-push-action@v2
      with:
        push: true
        tags: ${{ steps.prepare.outputs.tag }}

Customizing

inputs

Following inputs can be used as step.with keys

Name Type Description
docker_image String Docker image name e.g. name/app
default_branch String Default branch (default main). If not main, specify ${{ github.event.repository.default_branch }} or your default branch.
tag_with_sha String Tags the built image with the git short SHA prefixed with sha-.

See example config

outputs

Following outputs are available

  • tag: Smart tag

Development

Build

npm run build

Test

npm run build
npm t