Use canary binary (#1384)

This PR updates MMTk core CI to use `ci-perf-kit 0.8.4`
(mmtk/ci-perf-kit#49). It uses a binary build of
our OpenJDK binding releases, as the canary build.

Author: qinsoon

.github/workflows/micro-bm.yml

@@ -66,7 +66,7 @@ jobs:
         with:
           repository: mmtk/ci-perf-kit
           token: ${{ secrets.GITHUB_TOKEN }}
-          ref: "0.8.3"
+          ref: "0.8.4"
           path: ci-perf-kit
           submodules: true
       # Use rust-toolchain in the trunk (it doesnt matter much - if the toolchains defined in the trunk and the branch are different, we cant run anyway)

.github/workflows/perf-baseline.yml

@@ -42,7 +42,7 @@ jobs:
         with:
           token: ${{ secrets.CI_ACCESS_TOKEN }}
           repository: mmtk/ci-perf-kit
-          ref: "0.8.3"
+          ref: "0.8.4"
           path: ci-perf-kit
           submodules: true
       # setup
@@ -94,7 +94,7 @@ jobs:
         with:
           token: ${{ secrets.CI_ACCESS_TOKEN }}
           repository: mmtk/ci-perf-kit
-          ref: "0.8.3"
+          ref: "0.8.4"
           path: ci-perf-kit
           submodules: true
       # setup

.github/workflows/perf-compare-ci.yml

@@ -112,7 +112,7 @@ jobs:
             with:
               repository: mmtk/ci-perf-kit
               token: ${{ secrets.CI_ACCESS_TOKEN }}
-              ref: "0.8.3"
+              ref: "0.8.4"
               path: ci-perf-kit
               submodules: true
           # setup
@@ -219,7 +219,7 @@ jobs:
               with:
                 repository: mmtk/ci-perf-kit
                 token: ${{ secrets.CI_ACCESS_TOKEN }}
-                ref: "0.8.3"
+                ref: "0.8.4"
                 path: ci-perf-kit
                 submodules: true
             # setup

.github/workflows/perf-regression-ci.yml

@@ -45,7 +45,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           repository: mmtk/ci-perf-kit
-          ref: "0.8.3"
+          ref: "0.8.4"
           path: ci-perf-kit
           token: ${{ secrets.CI_ACCESS_TOKEN }}
           submodules: true
@@ -116,6 +116,9 @@ jobs:
       # available.  Then we may change to another release version and mark the change of canary on
       # the timeline, or introduce a mechanism to dynamically choose the canary version.
       CANARY_VERSION: "v0.28.0"
+      CANARY_RELEASE_BINARY_NAME: "jdk-11.0.19-internal+0_linux-x64_bin.tar.gz"
+      CANARY_JDK_NAME: "jdk-11.0.19"
+      CANARY_DIR: "canary"
     steps:
       # checkout latest versions
       - name: Checkout MMTk Core (latest)
@@ -136,29 +139,26 @@ jobs:
         uses: actions/checkout@v4
         with:
           repository: mmtk/ci-perf-kit
-          ref: "0.8.3"
+          ref: "0.8.4"
           path: ci-perf-kit
           submodules: true
-      # checkout canary versions.
-      - name: Checkout MMTk Core (canary)
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ env.CANARY_VERSION }}
-          path: canary/mmtk-core
-      - name: Checkout OpenJDK Binding (canary)
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ env.CANARY_VERSION }}
-          repository: mmtk/mmtk-openjdk
-          path: canary/mmtk-openjdk
-      - name: Checkout OpenJDK (canary)
-        working-directory: canary/mmtk-openjdk
+      # download canary build
+      # The tarball should be the standard product tarball from `make product-bundles` (see docs/team/release.md).
+      - name: Download canary build
+        env:
+          GH_TOKEN: ${{ secrets.CI_ACCESS_TOKEN }}
         run: |
-          ./.github/scripts/ci-checkout.sh
+          rm -rf ${{ env.CANARY_DIR }}
+          mkdir -p ${{ env.CANARY_DIR }}
+          gh release download ${{ env.CANARY_VERSION }} --repo mmtk/mmtk-openjdk --pattern "${{ env.CANARY_RELEASE_BINARY_NAME }}" --dir ${{ env.CANARY_DIR }}/images
+          cd ${{ env.CANARY_DIR}}/images
+          tar -xvzf ${{ env.CANARY_RELEASE_BINARY_NAME }}
+          mv ${{ env.CANARY_JDK_NAME }} jdk
+          rm ${{ env.CANARY_RELEASE_BINARY_NAME }}
       # setup
       - name: Setup directory structures
         run: |
-          for BASE_DIR in ./latest ./canary; do
+          for BASE_DIR in ./latest; do
             pushd $BASE_DIR
               # replace dependency
               # Note that ci-replace-mmtk-dep.sh will apply `realpath()` to the `--mmtk-core-path` option.
@@ -183,7 +183,7 @@ jobs:
           export FROM_DATE=2020-07-10
           ./ci-perf-kit/scripts/openjdk-history-run.sh \
             ./latest/mmtk-openjdk \
-            ./canary/mmtk-openjdk \
+            ${{ env.CANARY_DIR }} \
             ./reports/${{ steps.branch.outputs.branch_name }}
       # deploy
       - name: Deploy to Github Page
@@ -230,7 +230,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           repository: mmtk/ci-perf-kit
-          ref: "0.8.3"
+          ref: "0.8.4"
           path: ci-perf-kit
           token: ${{ secrets.CI_ACCESS_TOKEN }}
           submodules: true

docs/team/release.md

@@ -72,6 +72,14 @@ Once the PRs are merged, we can tag releases on Github.
 5. Tick 'Set as a pre-release'.
 6. Click 'Publish release'.
 
+#### OpenJDK Binary Release
+
+The OpenJDK binding release should also include the compiled binary packaged as a tarball.
+This tarball is used for the canary build in the performance CI. See [Regression Test Canary](https://github.com/mmtk/mmtk-core/blob/master/docs/team/ci.md#regression-test-canary).
+
+You can generate the tarball using OpenJDK’s `make product-bundles` command (with MMTk).
+Among the generated files, the one with the `*_bin.tar.gz` suffix should be included in the release.
+
 ### Post release checklist
 
 1. Keep an eye on the badges in [README](https://github.com/mmtk/mmtk-core#mmtk)