Docker

Images

Docker builds are automated and images are available in the following registries:

• Docker Hub
• GitHub Container Registry

Usage

The easiest way of running git-cliff (in the git root directory with configuration file present) is to use the available tags from Docker Hub:

docker run -t -v "$(pwd)":/app/ "orhunp/git-cliff:${TAG:-latest}"

Or you can use the image from the GitHub Package Registry:

docker run -t -v "$(pwd)":/app/ "ghcr.io/orhun/git-cliff/git-cliff:${TAG:-latest}"

Tags

Tags are generated from the CI and follow these rules:

• latest: only on version tag builds
• main: only on pushes to the main branch
• sha-<short>: commit SHA builds (e.g. sha-954106f)
• X.Y.Z: SemVer tag derived from Git tag (e.g. 2.12.0)

Building

Custom Docker images can be built from the Dockerfile:

DOCKER_BUILDKIT=1 docker build -t git-cliff .