mirror of
https://github.com/orhun/git-cliff.git
synced 2026-10-12 02:20:37 +00:00
Jonathan GarbeeandOrhun Parmaksız
9d2a52a3db
* feat(docker): apply latest tag to stable only This patch adds an enablement check to `latest` to only apply on tags. Then introduces a new `nightly` tag for all other builds for any automated testing to look for for un-stable work. * Modify Docker workflow for tagging and SHA extraction Updated Docker workflow to use 'main' tag for builds and added SHA tag extraction step. * Document Docker tags and CI generation rules Add section on Docker tags and their generation rules. * Enhance comments in docker.yml for SHA tag extraction Add comments to clarify the jq script for SHA tag extraction. * Rename SHA tag step and update image reference * Update website/docs/docker.md * Update website/docs/docker.md --------- Co-authored-by: Orhun Parmaksız <[email protected]>
1.3 KiB
1.3 KiB
sidebar_position
| sidebar_position |
|---|
| 8 |
Docker
Images
Docker builds are automated and images are available in the following registries:
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 buildsmain: only on pushes to themainbranchsha-<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 .