image-version

CLI tool and GitHub action to determine the container image version based on a git ref.
Take a look at program-version if you need the --version variant that programs normally output.

Installation

See the latest release for instructions.

Behavior

git ref	program version	prefix
refs/heads/main	latest	v
refs/heads/master	latest	v
refs/heads/ft-refactor	ft-refactor	v
refs/tags/v1.0.3	1.0.3	v
refs/tags/v1.0.3	1.0.3	v
refs/tags/1.0.3	1.0.3	v
refs/tags/very-pinned (prefix must be followed by a number)	very-pinned	v
refs/tags/v3ry-pinned	3ry-pinned	v
refs/tags/v	v	v
refs/tags/f1.0.3 (treated just like branches)	f1.0.3	v
e02d09699ffb56440f34cb7448a0bc436e3ae212 (i.e. non-symbolic)	e02d0969	v
e02d09699ffb56440f34cb7448 (not 40 hex chars)	error	v
master (no refs/heads/ prefix)	error	v
v1.0.3 (no refs/tags/ prefix)	error	v
refs/heads/ (empty branch name)	error	v
refs/tags/ (empty tag name)	error	v
Custom prefix
refs/heads/main	latest	mytool-v
refs/heads/mytool-vmain	mytool-vmain	mytool-v
refs/tags/v1.0.3	v1.0.3	mytool-v
refs/tags/mytool-v1.0.3	1.0.3	mytool-v
refs/tags/mytool-v1	1	mytool-v
refs/tags/mytool-v1.0.3 (prefix=v)	mytool-v1.0.3	v
refs/tags/1.0.3	1.0.3	mytool-v
refs/tags/mytool-very-pinned	mytool-very-pinned	mytool-v
refs/tags/mytool-v3ry-pinned	3ry-pinned	mytool-v
refs/tags/mytool-v	mytool-v	mytool-v

CLI

Usage

image-version REF

When using μpkg you can retrieve the installed version of your package and pass that straight to this tool (git symbolic-ref is used as a fallback in order for it to work in your git repo while developing):

PKGROOT=$(dirname "$(realpath "${BASH_SOURCE[0]}")")
version=$(image-version "$(jq -re '.version // empty' "$PKGROOT/upkg.json" 2>/dev/null || git -C "$PKGROOT" symbolic-ref HEAD)")

GitHub action

Inputs

Name	Description	Default
ref	The git ref to calculate the image tag from.	`${{ github.ref }} input
prefix	Prefix to remove in tags.	v

Outputs

Name	Description
version	The image tag.

Usage

name: Release

on:
  push:
    branches: [ '*' ]
    tags: [ 'v*' ]

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
    - id: image_version
      uses: orbit-online/image-version@v0.9.0
    - uses: actions/checkout@v4
    - uses: docker/setup-buildx-action@v2
    - uses: docker/login-action@v2
      with:
        username: ${{ secrets.DOCKER_HUB_USERNAME }}
        password: ${{ secrets.DOCKER_HUB_TOKEN_RW }}
    - name: Build & push
      uses: docker/build-push-action@v5
      with:
        file: Dockerfile
        tags: orbit-online/my-prog:${{ steps.image_version.outputs.version }}
        push: true