build: update ci for slack bot (#538)

.github/workflows/pr.yml

@@ -37,10 +37,9 @@ jobs:
 
  test:
  runs-on: ubuntu-latest-128
+ needs: staticcheck
  permissions: 
  pull-requests: write
- outputs:
- failures: ${{ steps.generate-job-summary.outputs.failures }}
  steps:
  - name: checkout code
  uses: actions/checkout@v4
@@ -69,69 +68,18 @@ jobs:
  go test -json -v -race -timeout=30m ./ecc/bn254/... 2>&1 | gotestfmt -hide=all | tee -a /tmp/gotest.log 
  GOARCH=386 go test -json -short -v -timeout=30m ./ecc/bn254/... 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
-
- # if we failed a test, we want to comment on the PR with the log
- - name: PR comment with file
- if: ${{ failure() }}
- uses: thollander/actions-comment-pull-request@v2
- with:
- filePath: /tmp/gotest.log
 
- 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/[email protected]
- 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/[email protected]
- 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 }}

.github/workflows/push.yml

@@ -79,62 +79,18 @@ jobs:
  go test -json -v -race -timeout=30m ./ecc/bn254/... 2>&1 | gotestfmt -hide=all | tee -a /tmp/gotest.log
  GOARCH=386 go test -json -short -v -timeout=30m ./ecc/bn254/... 2>&1 | gotestfmt -hide=all | tee -a /tmp/gotest.log
  
- - name: Generate job summary
- id: generate-job-summary
- if: startsWith(matrix.os, 'ubuntu') == true && 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/[email protected]
- 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": "${{ 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/[email protected]
- with:
- payload: |
- {
- "actor": "${{ github.actor }}",
- "repo": "${{ github.repository }}",
- "status": "SUCCESS",
- "title": "push to master ✅",
- "pr": ""
- }
- 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: "master"
+ run_id: ${{ github.run_id }}

.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

.gotestfmt/downloads.gotpl

@@ -36,4 +36,4 @@ This template contains the format for a package download.
  {{- end -}}
  ::endgroup::
  {{- end -}}
-{{- end -}}
+{{- end -}}

.gotestfmt/package.gotpl

@@ -1,42 +1,55 @@
 {{- /*gotype: github.com/gotesttools/gotestfmt/v2/parser.Package*/ -}}
-
+{{- /*
+This template contains the format for an individual package. GitHub actions does not currently support nested groups so
+we are creating a stylized header for each package.
+*/ -}}
 {{- $settings := .Settings -}}
 {{- if and (or (not $settings.HideSuccessfulPackages) (ne .Result "PASS")) (or (not $settings.HideEmptyPackages) (ne .Result "SKIP") (ne (len .TestCases) 0)) -}}
- 📦 `{{ .Name }}`
+ {{- if eq .Result "PASS" -}}
+ {{ "\033" }}[0;32m
+ {{- else if eq .Result "SKIP" -}}
+ {{ "\033" }}[0;33m
+ {{- else -}}
+ {{ "\033" }}[0;31m
+ {{- end -}}
+ 📦 {{ .Name }}{{- "\033" }}[0m
  {{- with .Coverage -}}
- ({{ . }}% coverage)
+ {{- "\033" -}}[0;37m ({{ . }}% coverage){{- "\033" -}}[0m
  {{- end -}}
  {{- "\n" -}}
  {{- with .Reason -}}
  {{- " " -}}🛑 {{ . -}}{{- "\n" -}}
  {{- end -}}
  {{- with .Output -}}
- ```{{- "\n" -}}
  {{- . -}}{{- "\n" -}}
- ```{{- "\n" -}}
  {{- end -}}
  {{- with .TestCases -}}
  {{- range . -}}
  {{- if or (not $settings.HideSuccessfulTests) (ne .Result "PASS") -}}
+ ::group::
  {{- if eq .Result "PASS" -}}
- ✅
+ {{ "\033" }}[0;32m✅
  {{- else if eq .Result "SKIP" -}}
- 🚧
+ {{ "\033" }}[0;33m🚧
  {{- else -}}
- ❌
+ {{ "\033" }}[0;31m❌
  {{- end -}}
- {{ " " }}`{{- .Name -}}` {{ .Duration -}}
+ {{ " " }}{{- .Name -}}
+ {{- "\033" -}}[0;37m ({{if $settings.ShowTestStatus}}{{.Result}}; {{end}}{{ .Duration -}}
+ {{- with .Coverage -}}
+ , coverage: {{ . }}%
+ {{- end -}})
+ {{- "\033" -}}[0m
  {{- "\n" -}}
 
  {{- with .Output -}}
- ```{{- "\n" -}}
- {{- formatTestOutput . $settings -}}{{- "\n" -}}
- ```{{- "\n" -}}
+ {{- formatTestOutput . $settings -}}
+ {{- "\n" -}}
  {{- end -}}
 
- {{- "\n" -}}
+ ::endgroup::{{- "\n" -}}
  {{- end -}}
  {{- end -}}
  {{- end -}}
  {{- "\n" -}}
-{{- end -}}
+{{- end -}}