Merge pull request #248 from Yubico/dennisdyallo/github-builds

ci: Add comprehensive summary for build

Author: DennisDyallo

.github/workflows/build.yml

@@ -47,7 +47,7 @@ on:
         type: string
   schedule:
     - cron: '0 0 * * *' # Every day at midnight
-        
+
 jobs:
   run-tests:
     name: Run tests
@@ -183,3 +183,48 @@ jobs:
           dotnet nuget add source --username ${{ github.actor }} --password ${{ secrets.GITHUB_TOKEN }} --store-password-in-clear-text --name github "https://nuget.pkg.github.com/Yubico/index.json"
           dotnet nuget push $core --source "github" --api-key ${{ secrets.GITHUB_TOKEN }}
           dotnet nuget push $yubikey --source "github" --api-key ${{ secrets.GITHUB_TOKEN }}
+
+  build-summary:
+    name: Build summary
+    runs-on: ubuntu-latest
+    needs: [build-artifacts, publish-internal, upload-docs] # Add upload-docs to needs
+    if: always() # Run this job even if other jobs fail
+    steps:
+      - name: Generate build summary
+        env:
+          # Pass job results and outputs into the step's environment
+          RUN_TESTS_RESULT: ${{ needs.run-tests.result }}
+          BUILD_ARTIFACTS_RESULT: ${{ needs.build-artifacts.result }}
+          UPLOAD_DOCS_RESULT: ${{ needs.upload-docs.result }}
+          PUBLISH_INTERNAL_RESULT: ${{ needs.publish-internal.result }}
+          DOCS_IMAGE_TAG: ${{ needs.upload-docs.outputs.image-tag }}
+        run: |
+          echo "## Build Summary" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "### Job Status" >> $GITHUB_STEP_SUMMARY
+          echo "| Job | Status |" >> $GITHUB_STEP_SUMMARY
+          echo "| --- | --- |" >> $GITHUB_STEP_SUMMARY
+          echo "| Run tests | **${{ env.RUN_TESTS_RESULT }}** |" >> $GITHUB_STEP_SUMMARY
+          echo "| Build artifacts | **${{ env.BUILD_ARTIFACTS_RESULT }}** |" >> $GITHUB_STEP_SUMMARY
+          echo "| Upload docs | **${{ env.UPLOAD_DOCS_RESULT }}** |" >> $GITHUB_STEP_SUMMARY
+          echo "| Publish to internal NuGet | **${{ env.PUBLISH_INTERNAL_RESULT }}** |" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+
+          echo "### Built Artifacts" >> $GITHUB_STEP_SUMMARY
+          echo "Links to artifacts produced by this build run:" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "- [Documentation log](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}/artifacts/Documentation_log)" >> $GITHUB_STEP_SUMMARY
+          echo "- [Documentation Site](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}/artifacts/Documentation)" >> $GITHUB_STEP_SUMMARY
+          echo "- [Nuget Packages](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}/artifacts/Nuget_Packages)" >> $GITHUB_STEP_SUMMARY
+          echo "- [Symbols Packages](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}/artifacts/Symbols_Packages)" >> $GITHUB_STEP_SUMMARY
+          echo "- [Assemblies](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}/artifacts/Assemblies)" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+
+          # Conditionally add the Docker image tag to the summary if the upload-docs job was successful
+          if [ "${{ env.UPLOAD_DOCS_RESULT }}" == "success" ]; then
+            echo "### Documentation Docker Image" >> $GITHUB_STEP_SUMMARY
+            echo "A new documentation Docker image was pushed with the tag:" >> $GITHUB_STEP_SUMMARY
+            echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
+            echo "${{ env.DOCS_IMAGE_TAG }}" >> $GITHUB_STEP_SUMMARY
+            echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
+          fi

.github/workflows/upload-docs.yml

@@ -14,8 +14,13 @@
 
 name: Upload documentation to GCP
 
-on: 
+on:
   workflow_call:
+    # Define an output for this reusable workflow
+    outputs:
+      image-tag:
+        description: "The full tag of the pushed documentation Docker image"
+        value: ${{ jobs.upload_docs.outputs.image-tag }}
 
 permissions:
   id-token: write
@@ -30,6 +35,9 @@ env:
 jobs:
   upload_docs:
     runs-on: ubuntu-latest
+    # Define an output for this job
+    outputs:
+      image-tag: ${{ steps.push_image.outputs.tag }}
     steps:
       # Checkout the local repository as we need the Dockerfile and other things even for this step.
       - uses: actions/checkout@v4
@@ -44,7 +52,7 @@ jobs:
       - name: Docker build
         run: |
           docker build -t "${IMAGE_NAME}:${{ github.sha }}" .
-      
+
       # Authenticate to Google Cloud
       - name: Authenticate
         uses: google-github-actions/auth@v2
@@ -54,8 +62,11 @@ jobs:
 
       # Push our docker image to GCP
       - name: Push Docker image
+        id: push_image # Add an ID to reference this step's outputs
         run: |
           gcloud auth configure-docker ${IMAGE_REGISTRY_URL} --project ${IMAGE_REGISTRY_PROJECT}
-          docker tag "${IMAGE_NAME}:${{ github.sha }}" "${IMAGE_REGISTRY_URL}/${IMAGE_REGISTRY_PROJECT}/${IMAGE_REPOSITORY}/${IMAGE_NAME}:${{ github.sha }}"
-          docker push "${IMAGE_REGISTRY_URL}/${IMAGE_REGISTRY_PROJECT}/${IMAGE_REPOSITORY}/${IMAGE_NAME}:${{ github.sha }}"
-          echo "New image tag: ${{ github.sha }}"
+          FULL_IMAGE_TAG="${IMAGE_REGISTRY_URL}/${IMAGE_REGISTRY_PROJECT}/${IMAGE_REPOSITORY}/${IMAGE_NAME}:${{ github.sha }}"
+          docker tag "${IMAGE_NAME}:${{ github.sha }}" "${FULL_IMAGE_TAG}"
+          docker push "${FULL_IMAGE_TAG}"
+          # Use GITHUB_OUTPUT to make the full tag available to the job and workflow
+          echo "tag=${FULL_IMAGE_TAG}" >> $GITHUB_OUTPUT