Fix: Set conformance commit in GitHub Action

It is not possible to inject the commit hash into the main package (though it works with "go test").
Instead, this exposes the default value from yaml and the env, but overrides it from git when possible.
This fixes the reports in the GitHub Actions that run without the .git directory.

Signed-off-by: Brandon Mitchell <git@bmitch.net>

Author: sudo-bmitch

Makefile

@@ -139,13 +139,12 @@ clean-ci:
 
 $(OUTPUT_DIRNAME)/conformance: conformance/*.go conformance/go.mod
 	cd conformance && \
-		CGO_ENABLED=0 go build -o $(shell pwd)/$(OUTPUT_DIRNAME)/conformance \
-			--ldflags="-X github.com/opencontainers/distribution-spec/conformance.Version=$(CONFORMANCE_VERSION)"
+		CGO_ENABLED=0 go build -o $(shell pwd)/$(OUTPUT_DIRNAME)/conformance .
 
 $(OUTPUT_DIRNAME)/conformance.test: conformance/*.go conformance/go.mod
 	cd conformance && \
 		CGO_ENABLED=0 go test -c -o $(shell pwd)/$(OUTPUT_DIRNAME)/conformance.test \
-			--ldflags="-X github.com/opencontainers/distribution-spec/conformance.Version=$(CONFORMANCE_VERSION)"
+			-ldflags "-X github.com/opencontainers/distribution-spec/conformance.Version=$(CONFORMANCE_VERSION)" .
 
 clean: clean-ci
 	rm -rf header.html junit.xml report.html results.yaml output conformance/results

action.yml

@@ -54,7 +54,7 @@ runs:
       run: |
         set -x
 
-        # Enter the directory containing the checkout of this action which is surpisingly hard to do (but we did it... #OCI)
+        # Enter the directory containing the checkout of this action which is surprisingly hard to do (but we did it... #OCI)
         cd "$(dirname $(find $(find ~/work/_actions -name distribution-spec -print -quit) -name Makefile -print -quit))"
         
         # The .git folder is not present, but the dirname is the requested action ref, so use this as the commit version
@@ -65,6 +65,7 @@ runs:
 
         # The spec version is independent of the conformance git commit
         echo "oci-spec-version=${OCI_VERSION:-stable}" >> $GITHUB_OUTPUT
+        echo "oci-commit=${commit_version}" >> $GITHUB_OUTPUT
 
         # Add bin to the PATH so we can just run "conformance"
         echo "${PWD}/bin" >> $GITHUB_PATH
@@ -75,7 +76,8 @@ runs:
       run: |
         set -x
         set +e
-        export OCI_RESULTS_DIR=${OCI_RESULTS_DIR:-.}
+        export OCI_RESULTS_DIR="${OCI_RESULTS_DIR:-.}"
+        export OCI_COMMIT="${{ steps.build-conformance.outputs.oci-commit }}"
         conformance
         conformance_rc="$?"
         set -e

conformance/README.md

@@ -21,6 +21,7 @@ export OCI_CONFIGURATION="oci-conformance.yaml" # see Yaml Configuration File be
 export OCI_RESULTS_DIR="./results" # output of the conformance test will be written here, see Results below
 export OCI_VERSION="1.1" # distribution-spec version to test against, this adjusts default values for the API tests, also accepts "stable" and "dev"
 export OCI_LOG="warn" # adjust logging threshold: debug, info, warn, error (this does not affect the generated reports)
+export OCI_COMMIT="unknown" # commit hash of the distribution-spec, this is auto detected from git when available
 
 # the registry settings typically need to be configured
 export OCI_REGISTRY="localhost:5000"
@@ -95,6 +96,7 @@ password: ""
 cacheAuth: true
 logging: warn
 filterTest: ""
+commit: "unknown"
 apis:
   pull: true
   push: true

conformance/config.go

@@ -42,7 +42,7 @@ type config struct {
 	ResultsDir string       `conformance:"RESULTS_DIR" yaml:"resultsDir"`           // directory to write results
 	Version    string       `conformance:"VERSION" yaml:"version"`                  // spec version used to set test defaults
 	schemeReg  string       `yaml:"-"`                                              // base for url to access the registry
-	Commit     string       `yaml:"commit"`                                         // injected git commit hash from runtime
+	Commit     string       `conformance:"COMMIT" yaml:"commit"`                    // injected git commit hash from runtime
 	Legacy     bool         `yaml:"legacy,omitempty"`                               // injected to indicate that conformance was run with "go test"
 }
 
@@ -155,6 +155,7 @@ func configLoad() (config, error) {
 		LogLevel:   "warn",
 		LogWriter:  os.Stderr,
 		ResultsDir: "./results",
+		Commit:     Version,
 		APIs: configAPI{
 			Ping: true,
 			Pull: true,
@@ -236,19 +237,15 @@ func configLoad() (config, error) {
 		scheme = "http"
 	}
 	c.schemeReg = fmt.Sprintf("%s://%s", scheme, c.Registry)
-	// load the commit from the build info
+	// load the commit from the build info when available, overriding any user provided value
 	if bi, ok := debug.ReadBuildInfo(); ok && bi != nil {
 		for _, setting := range bi.Settings {
-			if setting.Key == biVCSCommit {
+			if setting.Key == biVCSCommit && setting.Value != "" {
 				c.Commit = setting.Value
 				break
 			}
 		}
 	}
-	// fall back to version injected from the makefile ldflags parameter
-	if c.Commit == "" {
-		c.Commit = Version
-	}
 	return c, nil
 }