Skip to content
GitLab

[cli][docker] Better expose version/sha information of builds

Merged Jim Schubert requested to merge git-sha-versioning into master

CLI

  • Introduce --version image
  • Introduce --help image
  • Add --sha to version command for short SHA display image
  • Output Version and SHA details
  • In new --version output, display repo and doc site

Docker

This adds image labels to store metadata on the online and cli docker images, using standard labels:

  • org.opencontainers.image.created
  • org.opencontainers.image.revision
  • org.opencontainers.image.title
  • org.opencontainers.image.version

These can be inspected via 'docker inspect IMAGE_NAME' and may be useful in tooling/automation or bug reports submitted by users.

For more details on these labels, see: https://github.com/opencontainers/image-spec/blob/master/annotations.md

image

Useful pattern for inspection:

docker inspect \
  --format '{{range $key,$value := .Config.Labels}}{{$key}}={{$value}}{{printf "\n"}}{{end}}' \
  $IMAGE_NAME

cc @OpenAPITools/build cc @bkabrda

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.