added display version, hash and dirty in logs

[ehearneRedHat]

Kuadrant/authorino#471

What:

Added info log to display version, commit hash and whether the branch was dirty or not on build .

Verify:

Run make build and make local-setup locally. Without any file changes made the hash should be displayed without appendixed dirty flag. Then add a comment to a file to have git detect new changes and re-run the commands checking binary and in-cluster for both respectively.

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.80%. Comparing base (da27315) to head (3eb7709).
Report is 4 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #149      +/-   ##
==========================================
- Coverage   85.01%   84.80%   -0.21%     
==========================================
  Files          19       19              
  Lines         994      994              
==========================================
- Hits          845      843       -2     
- Misses         97       98       +1     
- Partials       52       53       +1     

Flag	Coverage Δ
integration	78.77% <ø> (-0.61%)	⬇️
unit	66.51% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
api/v1alpha1 (u)	100.00% <ø> (ø)
pkg/helpers (u)	83.87% <ø> (ø)
pkg/log (u)	94.73% <ø> (ø)
pkg/reconcilers (u)	74.67% <ø> (ø)
pkg/limitador (u)	98.11% <ø> (ø)
controllers (i)	74.66% <ø> (-0.67%)	⬇️
pkg/upgrades	88.88% <ø> (ø)

see 1 file with indirect coverage changes

[eguzki]

The github action should propagate COMMIT from ${{ github.sha }}

https://github.com/Kuadrant/limitador-operator/blob/main/.github/workflows/build-images-base.yaml#L68-L76

[eguzki]

missing propagation of docker args on github actions to build images. Here: .github/workflows/build-images-base.yaml

I tested functionality and works as expected:

if .git does not exists -> dirty = unknown
if git diff --stat returns something -> dirty = true
else -> dirty = false

I wrote a little check-git-dirty.sh bash script that does the same. For me it is more readable. But this is quite a matter of personal taste, so I leave up to you. Both scripts are good enough IMO.

#!/usr/bin/env bash

if ! command -v git &>/dev/null 
then
    echo "git not found..." >&2
    exit 1
fi

if output=$(git diff --stat 2>/dev/null)
then
[ -n "$output" ] && echo "true" || echo "false"
else
    # Not a git repository
    exit 1
fi

I am using the script like this:

run: DIRTY=$(shell $(PROJECT_PATH)/utils/check-git-dirty.sh || echo "unknown")
run: manifests generate fmt vet ## Run a controller from your host.)
        go run -ldflags "-X main.gitSHA=${GIT_SHA} -X main.dirty=${DIRTY}" ./main.go

[ehearneRedHat]

@eguzki all done . :)