feat: Include conformance action version in client report (#283)

* feat: Include conformance action version in client report

* Add pytest-metadata as top-level dependency

* Use pytest-metadata instead

---------

Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>
Co-authored-by: Jussi Kukkonen <jkukkonen@google.com>

Author: di

.github/scripts/generate_client_report.py

@@ -19,6 +19,7 @@ class Result:
     skipped: int = -1
     rekor2_verify: bool = False
     rekor2_sign: bool = False
+    conformance_action_version: str = "unknown"
     client_sha: str = ""
     client_sha_url: str = ""
     workflow_run: str = ""
@@ -36,6 +37,10 @@ def __init__(self, report_path: Path):
             return  # no results found
         self.results_found = True
 
+        self.conformance_action_version = data.get("environment", {}).get(
+            "conformance_action_version", "unknown"
+        )
+
         summary = data["summary"]
         self.total = summary["total"]
         self.passed = summary.get("passed", 0) + summary.get("subtests passed", 0)
@@ -81,6 +86,7 @@ def _generate_html(results: list[Result]):
                     <th>Xfailed</th>
                     <th>Rekor v2 verify</th>
                     <th>Rekor v2 sign</th>
+                    <th>Action Version</th>
                 </tr>
             </thead>
             <tbody>
@@ -110,6 +116,7 @@ def _generate_html(results: list[Result]):
                     <td>{res.xfailed if res.results_found else ""}</td>
                     <td>{"✅" if res.rekor2_verify else "❌"}</td>
                     <td>{"✅" if res.rekor2_sign else "❌"}</td>
+                    <td>{res.conformance_action_version}</td>
                 </tr>
         """
     html += """

action.py

@@ -4,6 +4,7 @@
 #
 # all state is passed in as environment variables
 
+import json
 import os
 import sys
 from pathlib import Path
@@ -29,6 +30,9 @@ def _debug(msg):
 def _sigstore_conformance(environment: str) -> int:
     args = ["--json-report", "--json-report-file=conformance-report.json", "--durations=0"]
 
+    version = os.getenv("GHA_SIGSTORE_CONFORMANCE_ACTION_VERSION", "unknown")
+    args.extend(["--metadata", "conformance_action_version", version])
+
     if _DEBUG:
         args.extend(["-s", "-vv", "--showlocals"])
 

action.yml

@@ -52,6 +52,11 @@ runs:
         echo "::endgroup::"
       shell: bash
 
+    - name: Get action version
+      id: get_action_version
+      run: echo "action_version=$(git describe --tags --always)" >> $GITHUB_OUTPUT
+      shell: bash
+
     - name: Run sigstore-conformance
       id: sigstore-conformance
       run: |
@@ -67,6 +72,7 @@ runs:
         GHA_SIGSTORE_CONFORMANCE_CLIENT_SHA_URL: "${{ github.server_url }}/${{ github.repository }}/commit/${{ github.sha }}"
         GHA_SIGSTORE_CONFORMANCE_WORKFLOW_RUN: "${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"
         GHA_SIGSTORE_CONFORMANCE_SELFTEST_BIN: "${{ github.workspace }}/sigstore-conformance-selftest-env/bin/sigstore"
+        GHA_SIGSTORE_CONFORMANCE_ACTION_VERSION: "${{ steps.get_action_version.outputs.action_version }}"
       shell: bash
 
     - name: Upload conformance result

requirements.in

@@ -1,5 +1,6 @@
 pytest==8.4.2
 pytest-json-report==1.5.0
+pytest-metadata==3.1.1
 pytest-subtests==0.15.0
 requests==2.32.5
 cryptography==46.0.3

requirements.txt

@@ -603,7 +603,9 @@ pytest-json-report==1.5.0 \
 pytest-metadata==3.1.1 \
     --hash=sha256:c8e0844db684ee1c798cfa38908d20d67d0463ecb6137c72e91f418558dd5f4b \
     --hash=sha256:d2a29b0355fbc03f168aa96d41ff88b1a3b44a3b02acbe491801c98a048017c8
-    # via pytest-json-report
+    # via
+    #   -r requirements.in
+    #   pytest-json-report
 pytest-subtests==0.15.0 \
     --hash=sha256:cb495bde05551b784b8f0b8adfaa27edb4131469a27c339b80fd8d6ba33f887c \
     --hash=sha256:da2d0ce348e1f8d831d5a40d81e3aeac439fec50bd5251cbb7791402696a9493