From 2d7a775175ca7593e3b10517c22289da10f6f6dd Mon Sep 17 00:00:00 2001
From: Tom French <15848336+TomAFrench@users.noreply.github.com>
Date: Tue, 27 Aug 2024 18:54:44 +0100
Subject: [PATCH] chore: open an issue if publishing bb fails (#8223)

This PR adds a `build-check` step to the release workflow. This step
just checks whether any of the previous steps have failed and if so,
raises an issue before failing itself, otherwise we continue on to
uploading the release artifacts.

I've added @ludamad and @PhilWindle as people who would be assigned to
the created issue. Feel free to adjust this to whoever would be most
appropriate.

---------

Co-authored-by: ludamad <adam.domurad@gmail.com>
---
 .github/RELEASE_FAILED.md        |  8 ++++++
 .github/workflows/publish-bb.yml | 43 +++++++++++++++++++++++++++++---
 2 files changed, 47 insertions(+), 4 deletions(-)
 create mode 100644 .github/RELEASE_FAILED.md

diff --git a/.github/RELEASE_FAILED.md b/.github/RELEASE_FAILED.md
new file mode 100644
index 00000000000..32399d0bd52
--- /dev/null
+++ b/.github/RELEASE_FAILED.md
@@ -0,0 +1,8 @@
+---
+title: "Nightly release failed"
+assignees: fcarreiro, ludamad
+---
+
+The most recent nightly release failed. This means that no `bb` artifacts were published (which are required by Noir).
+
+Check the [{{env.WORKFLOW_NAME}}]({{env.WORKFLOW_URL}}) workflow for details.
diff --git a/.github/workflows/publish-bb.yml b/.github/workflows/publish-bb.yml
index fc80972a73f..ec489f03244 100644
--- a/.github/workflows/publish-bb.yml
+++ b/.github/workflows/publish-bb.yml
@@ -93,7 +93,7 @@ jobs:
           sudo cp -r clang+llvm-16.0.0-x86_64-linux-gnu-ubuntu-18.04/lib/* /usr/local/lib/
           sudo cp -r clang+llvm-16.0.0-x86_64-linux-gnu-ubuntu-18.04/share/* /usr/local/share/
 
-      - name: Install yarn # Needed to call 'yarn build' on barretenberg/ts 
+      - name: Install yarn # Needed to call 'yarn build' on barretenberg/ts
         run: |
           curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
           echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
@@ -152,7 +152,7 @@ jobs:
           export PATH="/usr/local/opt/llvm@16/bin:$PATH"
           export LDFLAGS="-L/usr/local/opt/llvm@16/lib"
           export CPPFLAGS="-I/usr/local/opt/llvm@16/include"
-          cmake -DCMAKE_BUILD_TYPE=RelWithAssert --preset default 
+          cmake -DCMAKE_BUILD_TYPE=RelWithAssert --preset default
           cmake --build --preset default --target bb
 
       - name: Package barretenberg artifact
@@ -170,7 +170,7 @@ jobs:
           retention-days: 3
 
   build-mac-m1:
-    name: Build on Mac aarch64-apple-darwin 
+    name: Build on Mac aarch64-apple-darwin
     runs-on: macos-14
     steps:
       - name: Checkout
@@ -201,9 +201,44 @@ jobs:
           path: ./barretenberg/cpp/build/bin/barretenberg-aarch64-apple-darwin.tar.gz
           retention-days: 3
 
+  build-check:
+    name: Check builds are successful
+    needs: [build-x86_64-linux-gnu, build-mac-intel, build-mac-m1,build-wasm-ts]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Report overall success
+        env:
+          FAIL: ${{ contains(needs.*.result, 'failure') }}
+        run: |
+          if [[ $FAIL == true ]]; then
+              echo "At least one job failed, release is unsuccessful."
+              exit 1
+          else
+              echo "All jobs succeeded, uploading artifacts to release."
+              exit 0
+          fi
+
+      - name: Checkout
+        uses: actions/checkout@v3
+        if: ${{ failure() }}
+        with:
+          ref: ${{ inputs.tag || env.GITHUB_REF }}
+
+      # Raise an issue if the release failed
+      - name: Alert on dead links
+        uses: JasonEtco/create-an-issue@1b14a70e4d8dc185e5cc76d3bec9eab20257b2c5 # v2.9.2
+        if: ${{ failure() }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          WORKFLOW_NAME: ${{ github.workflow }}
+          WORKFLOW_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+        with:
+          update_existing: true
+          filename: .github/RELEASE_FAILED.md
+
   release:
     name: Publish
-    needs: [build-x86_64-linux-gnu, build-mac-intel, build-mac-m1,build-wasm-ts]
+    needs: [build-check]
     runs-on: ubuntu-latest
     steps:
       - name: Download files from Linux Runner