/.github/{scripts,workflows}: add pull-report workflow, add script for updating readme with perf and correctness

.github/scripts/update-perf.sh

@@ -0,0 +1,84 @@
+#!/bin/bash
+
+set -ex
+set -o pipefail
+
+root="`dirname \"$0\"`"
+dir="`realpath \"$root\"`"
+doltgres_root="`realpath \"$dir/../../\"`"
+
+version=""
+sed_cmd_i=""
+start_marker=""
+end_marker=""
+
+dest_file="$doltgres_root/README.md"
+os_type="darwin"
+
+start_template='<!-- START_%s_RESULTS_TABLE -->'
+end_template='<!-- END_%s_RESULTS_TABLE -->'
+
+if [ "$#" -ne 3 ]; then
+  echo "Must supply version and type, eg update-perf.sh 'v0.39.0' 'latency|correctness' '/path/to/file'"
+  exit 1;
+fi
+
+version="$1"
+type="$2"
+new_table="$3"
+
+if [[ "$OSTYPE" == "linux-gnu"* ]]; then
+  os_type="linux"
+fi
+
+
+if [ "$type" == "latency" ]
+then
+  # update the version
+  if [ "$os_type" == "linux" ]
+  then
+    sed -i 's/Here are the benchmarks for DoltgreSQL version `'".*"'`/Here are the benchmarks for DoltgreSQL version `'"$version"'`/' "$dest_file"
+  else
+    sed -i '' "s/Here are the benchmarks for DoltgreSQL version \\\`.*\\\`/Here are the benchmarks for DoltgreSQL version \\\`$version\\\`/" "$dest_file"
+  fi
+
+  start_marker=$(printf "$start_template" "LATENCY")
+  end_marker=$(printf "$end_template" "LATENCY")
+
+else
+  # update the version
+  if [ "$os_type" == "linux" ]
+  then
+    sed -i 's/Here are DoltgreSQL'"'"'s sqllogictest results for version `'".*"'`./Here are DoltgreSQL'"'"'s sqllogictest results for version `'"$version"'`./' "$dest_file"
+  else
+    sed -i '' 's/Here are DoltgreSQL'"'"'s sqllogictest results for version `'".*"'`./Here are DoltgreSQL'"'"'s sqllogictest results for version `'"$version"'`./' "$dest_file"
+  fi
+
+  start_marker=$(printf "$start_template" "CORRECTNESS")
+  end_marker=$(printf "$end_template" "CORRECTNESS")
+fi
+
+# store in variable
+updated=$(cat "$new_table")
+updated_with_markers=$(printf "$start_marker\n$updated\n$end_marker\n")
+
+echo "$updated_with_markers" > "$new_table"
+
+if [ "$type" == "latency" ]
+then
+  if [ "$os_type" == "linux" ]
+  then
+    sed -e '/<!-- END_LATENCY/r '"$new_table"'' -e '/<!-- START_LATENCY/,/<!-- END_LATENCY/d' "$dest_file" > temp.md
+  else
+    sed -e '/\<!-- END_LATENCY/r '"$new_table"'' -e '/\<!-- START_LATENCY/,/\<!-- END_LATENCY/d' "$dest_file" > temp.md
+  fi
+else
+  if [ "$os_type" == "linux" ]
+  then
+    sed -e '/<!-- END_CORRECTNESS/r '"$new_table"'' -e '/<!-- START_CORRECTNESS/,/<!-- END_CORRECTNESS/d' "$dest_file" > temp.md
+  else
+    sed -e '/\<!-- END_CORRECTNESS/r '"$new_table"'' -e '/\<!-- START_CORRECTNESS/,/\<!-- END_CORRECTNESS/d' "$dest_file" > temp.md
+  fi
+fi
+
+mv temp.md "$dest_file"

.github/workflows/pull-report.yaml

@@ -0,0 +1,54 @@
+name: Post to Pull Request
+
+on:
+  repository_dispatch:
+    types: [ pull-report ]
+
+permissions:
+  id-token: write # This is required for requesting the JWT
+  contents: read  # This is required for actions/checkout
+
+jobs:
+  report-pull-request:
+    name: Report Performance Benchmarks on Pull Request
+    runs-on: ubuntu-22.04
+    if: ${{ github.event.client_payload.issue_number != -1 }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Configure AWS Credentials
+        uses: aws-actions/[email protected]
+        with:
+          role-session-name: GitHub_to_AWS_via_FederatedOIDC
+          role-to-assume: ${{ secrets.AWS_ROLE_TO_ASSUME_CORP }}
+          aws-region: us-west-2
+      - name: Get benchmark results
+        id: get-results
+        run: aws s3api get-object --bucket="$BUCKET" --key="$KEY" results.log
+        env:
+          KEY: ${{ github.event.client_payload.key }}
+          BUCKET: ${{ github.event.client_payload.bucket }}
+      - name: Post results to PR
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{ secrets.REPO_ACCESS_TOKEN || secrets.GITHUB_TOKEN }}
+          script: |
+            const { ACTOR, FORMAT, ISSUE_NUMBER, GITHUB_WORKSPACE } = process.env;
+            const issue_number = parseInt(ISSUE_NUMBER, 10);
+            const { owner, repo } = context.repo;
+            fs = require('fs');
+            fs.readFile(`${GITHUB_WORKSPACE}/results.log`, 'utf8', function (err,data) {
+              if (err) {
+                return console.log(err);
+              }
+              return github.rest.issues.createComment({
+                issue_number,
+                owner,
+                repo,
+                body: `@${ACTOR} ${FORMAT}\n ${data}`
+              });
+            });
+        env:
+          ACTOR: ${{ github.event.client_payload.actor }}
+          ISSUE_NUMBER: ${{ github.event.client_payload.issue_number }}
+          FORMAT: ${{ github.event.client_payload.noms_bin_format }}

README.md

@@ -171,17 +171,30 @@ Please follow the [Contributor's Guide](https://github.com/dolthub/doltgresql/bl
 
 # Performance
 
-Dolt is [1.7X slower than MySQL](https://docs.dolthub.com/sql-reference/benchmarks/latency) as measured by 
-a standard suite of Sysbench tests. 
+Dolt is [1.7X slower than MySQL](https://docs.dolthub.com/sql-reference/benchmarks/latency) as measured by
+a standard suite of Sysbench tests.
 
-Similar tests for Doltgres vs Postgres coming soon. 
+We use these same Sysbench tests to benchmark DoltgreSQL and compare the results to PostgreSQL. 
+
+Here are the benchmarks for DoltgreSQL version `0.3.0`.
+
+<!-- START_LATENCY_RESULTS_TABLE -->
+<!-- END_LATENCY_RESULTS_TABLE -->
+<br/>
 
 # Correctness
 
 Dolt is [99.99% compatible](https://docs.dolthub.com/sql-reference/benchmarks/correctness) with MySQL based on a 
 standard suite of correctness tests called `sqllogictest`.
 
-A similar comparison for Doltgres coming soon.
+We use these same tests to measure the correctness of DoltgreSQL.
+
+Here are DoltgreSQL's sqllogictest results for version `0.3.0`.  Tests that
+did not run could not complete due to a timeout earlier in the run.
+
+<!-- START_CORRECTNESS_RESULTS_TABLE -->
+<!-- END_CORRECTNESS_RESULTS_TABLE -->
+<br/>
 
 # Architecture