Provide image description

[asbjornu]

Currently there's no description LABEL added to our Docker images. We should probably provide one.

[arturcic]

@asbjornu Please provide a message that will be set as Description.

We actually might need 3 descriptions, one for the deps images, build-images and gitversion. At each level different description.

Can you provide them and I can implement them?

[asbjornu]

Right. Is it possible to interpolate the environment, architecture, OS version, etc., into the descriptions?

[arturcic]

These are the LABELs we can use
https://github.com/opencontainers/image-spec/blob/main/annotations.md.

Is it possible to interpolate the environment, architecture, OS version, etc., into the descriptions?

I think that is doable, as we are already appending programatically the dockerfile with additional content

[asbjornu]

How does the deps, build-images and gitversion images differ? As in, how are they used? Only the gitversion images are consumed directly, no?

[arturcic]

How does the deps, build-images and gitversion images differ? As in, how are they used? Only the gitversion images are consumed directly, no?

deps - these are the distributions + some dependencies

build-images are deps + dotnet sdk or dotnet runtime

build-images (sdk) are used for testing the artifacts when we validate the build

build-images(runtime) + gitversion tool = gitversion image that we publish

[arturcic]

build-images I think are also used by libgit2sharp to validate their build, at least that is what I contributed with there

[asbjornu]

This is what I think we should annotate the GitVersion Docker images with:

LABEL	Value
org.opencontainers.image.created	2023-12-29T13:35:12Z
org.opencontainers.image.authors	GitVersion Maintainers
org.opencontainers.image.url	The URL to the published image in the appropriate registry.
org.opencontainers.image.documentation	https://gitversion.net/docs/usage/docker (once GitTools/GitVersion#3858 is merged)
org.opencontainers.image.source	https://github.com/GitTools/GitVersion/blob/main/build/docker/Dockerfile
org.opencontainers.image.version	The same version as that of the packaged GitVersion binary.
org.opencontainers.image.revision	SHA of the GitVersion commit that was tagged and built.
org.opencontainers.image.vendor	GitTools
org.opencontainers.image.licenses	MIT
org.opencontainers.image.ref.name	6.0.0-beta.3-fedora.36-6.0-arm64
org.opencontainers.image.title	GitVersion
org.opencontainers.image.description	From git log to SemVer in no time
org.opencontainers.image.base.digest	Seems complicated to generate, so we can probably just punt on this one.
org.opencontainers.image.base.name	$REGISTRY/gittools/build-images:$DISTRO-sdk-$DOTNET_VERSION

I'm not sure what should be done for deps and build-images, but many of the values can most likely be reused.