Merge remote-tracking branch 'origin/master' into pr

Consensys · Nov 22, 2024 · fd62f9b · fd62f9b
2 parents bb7d861 + 7512178
commit fd62f9b
Show file tree

Hide file tree

Showing 88 changed files with 4,640 additions and 1,041 deletions.
diff --git a/.github/parse-tests.js b/.github/parse-tests.js
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -1,5 +1,6 @@
 on: pull_request
 name: pull_request
+
 jobs:
   staticcheck:
     runs-on: ubuntu-latest
@@ -24,23 +25,17 @@ jobs:
         git update-index --assume-unchanged go.sum
         if [[ -n $(git status --porcelain) ]]; then echo "git repo is dirty after running go generate -- please don't modify generated files"; echo $(git diff);echo $(git status --porcelain); exit 1; fi
 
-     # hack to ensure golanglint process generated files
-    - name: remove "generated by" comments from generated files 
-      run: |
-        find . -type f -name '*.go' -exec sed -i 's/Code generated by .* DO NOT EDIT/FOO/g' {} \;
-      # on macos: find . -type f -name '*.go' -exec sed -i '' -E 's/Code generated by .* DO NOT EDIT/FOO/g' {} \;
     - name: golangci-lint
       uses: golangci/golangci-lint-action@v6
       with:
           version: v1.60
           args: -v --timeout=5m
 
   test:
+    needs: staticcheck
     runs-on: ubuntu-latest-128
     permissions: 
       pull-requests: write
-    outputs:
-      failures: ${{ steps.generate-job-summary.outputs.failures }}
     steps:
     - name: checkout code
       uses: actions/checkout@v4
@@ -75,62 +70,18 @@ jobs:
         go test -json -v -p 4 -tags=prover_checks ./examples/... 2>&1 | gotestfmt -hide=all | tee -a /tmp/gotest.log
         go test -json -v -run=NONE -fuzz=FuzzIntcomp -fuzztime=30s ./internal/backend/ioutils 2>&1 | gotestfmt -hide=all | tee -a /tmp/gotest.log
 
-    - name: Generate job summary
-      id: generate-job-summary
-      if: ${{ always() }}
-      run: |
-        if [ -s /tmp/gotest.log ]; then
-          cat /tmp/gotest.log > $GITHUB_STEP_SUMMARY
-          echo "failures=$(cat /tmp/gotest.log | node .github/parse-tests.js)" > $GITHUB_OUTPUT
-        else
-          echo "## Success ✅" > $GITHUB_STEP_SUMMARY
-          echo "failures=" > $GITHUB_OUTPUT
-        fi
 
-  slack-workflow-status-failed:
-    if: failure()
-    name: post workflow status to slack
+  slack-notifications:
+    if: always()
+    uses: ./.github/workflows/slack-notifications.yml
     needs:
-      - staticcheck
       - test
-    runs-on: ubuntu-latest
-    steps:
-      - name: Notify slack -- workflow failed
-        id: slack
-        uses: slackapi/slack-github-action@v1.26.0
-        with:
-          payload: |
-            {
-              "actor": "${{ github.actor }}",
-              "repo": "${{ github.repository }}",
-              "status": "FAIL",
-              "title": "${{ github.event.pull_request.title }}",
-              "pr": "${{ github.event.pull_request.head.ref }}",
-              "failed_step_url": "${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}/",
-              "message": "${{ needs.test.outputs.failures }}"
-            }
-        env:
-          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
-
-  slack-workflow-status-success:
-    if: success()
-    name: post workflow status to slack
-    needs:
       - staticcheck
-      - test
-    runs-on: ubuntu-latest
-    steps:
-      - name: Notify slack -- workflow succeeded
-        id: slack
-        uses: slackapi/slack-github-action@v1.26.0
-        with:
-          payload: |
-            {
-              "actor": "${{ github.actor }}",
-              "repo": "${{ github.repository }}",
-              "status": "SUCCESS",
-              "title": "${{ github.event.pull_request.title }}",
-              "pr": "${{ github.event.pull_request.head.ref }}"
-            }
-        env:
-          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_SUCCESS }}
+    secrets:
+      SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
+    with:
+      status: ${{ needs.staticcheck.result }}${{ needs.test.result }}
+      actor: ${{ github.actor }}
+      repository: ${{ github.repository }}
+      branch: ${{ github.event.pull_request.head.ref }}
+      run_id: ${{ github.run_id }}
diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml
@@ -3,6 +3,7 @@ on:
     branches:
       - 'master'
 name: push_master
+
 jobs:
   staticcheck:
     runs-on: ubuntu-latest
@@ -27,11 +28,6 @@ jobs:
         git update-index --assume-unchanged go.sum
         if [[ -n $(git status --porcelain) ]]; then echo "git repo is dirty after running go generate -- please don't modify generated files"; echo $(git diff);echo $(git status --porcelain); exit 1; fi
 
-     # hack to ensure golanglint process generated files
-    - name: remove "generated by" comments from generated files 
-      run: |
-        find . -type f -name '*.go' -exec sed -i 's/Code generated by .* DO NOT EDIT/FOO/g' {} \;
-      # on macos: find . -type f -name '*.go' -exec sed -i '' -E 's/Code generated by .* DO NOT EDIT/FOO/g' {} \;
     - name: golangci-lint
       uses: golangci/golangci-lint-action@v6
       with:
@@ -81,51 +77,18 @@ jobs:
         go test -v -p 4 -timeout=50m -tags=release_checks -short -race ./test/...
         go test -v -run=NONE -fuzz=FuzzIntcomp -fuzztime=30s ./internal/backend/ioutils
 
-  
-  slack-workflow-status-failed:
-    if: failure()
-    name: post workflow status to slack
-    needs:
-      - staticcheck
-      - test
-    runs-on: ubuntu-latest
-    steps:
-      - name: Notify slack -- workflow failed
-        id: slack
-        uses: slackapi/slack-github-action@v1.26.0
-        with:
-          payload: |
-            {
-              "actor": "${{ github.actor }}",
-              "repo": "${{ github.repository }}",
-              "status": "FAIL",
-              "title": "push to master ⚠",
-              "pr": "",
-              "failed_step_url": "${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}/",
-              "message": ""
-            }
-        env:
-          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
 
-  slack-workflow-status-success:
-    if: success()
-    name: post workflow status to slack
+  slack-notifications:
+    if: always()
+    uses: ./.github/workflows/slack-notifications.yml
     needs:
-      - staticcheck
       - test
-    runs-on: ubuntu-latest
-    steps:
-      - name: Notify slack -- workflow succeeded
-        id: slack
-        uses: slackapi/slack-github-action@v1.26.0
-        with:
-          payload: |
-            {
-              "actor": "${{ github.actor }}",
-              "repo": "${{ github.repository }}",
-              "status": "SUCCESS",
-              "title": "push to master ✅",
-              "pr": ""
-            }
-        env:
-          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_SUCCESS }}
+      - staticcheck
+    secrets:
+      SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
+    with:
+      status: ${{ needs.staticcheck.result }}${{ needs.test.result }}
+      actor: ${{ github.actor }}
+      repository: ${{ github.repository }}
+      branch: "master"
+      run_id: ${{ github.run_id }}
diff --git a/.github/workflows/slack-notifications.yml b/.github/workflows/slack-notifications.yml
@@ -0,0 +1,85 @@
+# .github/workflows/slack-notifications.yml
+name: Slack Notifications
+
+on:
+  workflow_call:
+    secrets:
+      SLACK_BOT_TOKEN:
+        required: true
+    inputs:
+      status:
+        description: 'The status of the workflow (successsuccess or failure)'
+        required: true
+        type: string
+      actor:
+        description: 'The GitHub actor'
+        required: true
+        type: string
+      repository:
+        description: 'The GitHub repository'
+        required: true
+        type: string
+      branch:
+        description: 'The branch name'
+        required: true
+        type: string
+      run_id:
+        description: 'The workflow run ID'
+        required: true
+        type: string
+
+jobs:
+  notify_slack:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Post to Slack
+        run: |
+          if [ "${{ inputs.status }}" == "successsuccess" ]; then
+            payload=$(jq -n --arg repository "${{ inputs.repository }}" --arg branch "${{ inputs.branch }}" --arg actor "${{ inputs.actor }}" --arg run_id "${{ inputs.run_id }}" '{
+              "channel": "team-gnark-build",
+              "text": "GitHub Action build result: success",
+              "blocks": [
+                {
+                    "type": "section",
+                    "text": {
+                        "type": "mrkdwn",
+                        "text": ":large_green_circle: *All checks have passed:* *\($branch)* :white_check_mark:"
+                    },
+                },
+                {
+                  "type": "context",
+                  "elements": [
+                    {
+                      "type": "mrkdwn",
+                      "text": "\($repository) -- \($actor) -- <https://github.com/\($repository)/actions/runs/\($run_id)|View details>"
+                    }
+                  ]
+                }
+              ]
+            }')
+          else
+            payload=$(jq -n --arg repository "${{ inputs.repository }}" --arg branch "${{ inputs.branch }}" --arg actor "${{ inputs.actor }}" --arg run_id "${{ inputs.run_id }}" '{
+              "channel": "team-gnark-build",
+              "text": "GitHub Action build result: failure",
+              "blocks": [
+                {
+                    "type": "section",
+                    "text": {
+                        "type": "mrkdwn",
+                        "text": ":red_circle: *Failed run:* *\($branch)*"
+                    },
+                },
+                {
+                  "type": "context",
+                  "elements": [
+                    {
+                      "type": "mrkdwn",
+                      "text": "\($repository) -- \($actor) -- <https://github.com/\($repository)/actions/runs/\($run_id)|View details>"
+                    }
+                  ]
+                }
+              ]
+            }')
+          fi
+          response=$(curl -s -X POST -H 'Content-type: application/json; charset=utf-8' --data "$payload" https://slack.com/api/chat.postMessage -H "Authorization: Bearer ${{ secrets.SLACK_BOT_TOKEN }}" )
+        shell: bash
diff --git a/.golangci.yml b/.golangci.yml
@@ -13,5 +13,7 @@ linters-settings:
   gosec:
     excludes:
       - G115 # Conversions from int -> uint etc.
+issues:
+  exclude-generated: disable
 run:
   issues-exit-code: 1
diff --git a/.gotestfmt/downloads.gotpl b/.gotestfmt/downloads.gotpl
@@ -5,32 +5,35 @@ This template contains the format for a package download.
 {{- $settings := .Settings -}}
 {{- if or .Packages .Reason -}}
     {{- if or (not .Settings.HideSuccessfulDownloads) .Failed -}}
+        ::group::
         {{- if .Failed -}}
-            ❌
+            {{ "\033" }}[0;31m❌
         {{- else -}}
-            📥
+            {{ "\033" }}[0;34m📥
         {{- end -}}
-        {{ " " }} Dependency downloads
-        {{ "\n" -}}
+        {{ " " }}Dependency downloads
+        {{- "\033" }}[0m{{ "\n" -}}
 
         {{- range .Packages -}}
             {{- if or (not $settings.HideSuccessfulDownloads) .Failed -}}
                 {{- "   " -}}
                 {{- if .Failed -}}
-                    ❌
+                    {{ "\033" }}[0;31m❌
                 {{- else -}}
                     📦
                 {{- end -}}
                 {{- " " -}}
                 {{- .Package }} {{ .Version -}}
+                {{- "\033" }}[0m
                 {{- "\n" -}}
                 {{ with .Reason -}}
                     {{- "     " -}}{{ . -}}{{ "\n" -}}
                 {{- end -}}
             {{- end -}}
         {{- end -}}
         {{- with .Reason -}}
-        {{- "   " -}}🛑 {{ . }}{{ "\n" -}}
+        {{- "   " -}}{{- "\033" }}[0;31m🛑 {{ . }}{{- "\033" }}[0m{{ "\n" -}}
         {{- end -}}
+        ::endgroup::
     {{- end -}}
-{{- end -}}
+{{- end -}}