Integrate ASV with Nox

.github/workflows/benchmark.yml

@@ -14,29 +14,34 @@ jobs:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - uses: actions/checkout@v2
 
-      - name: Checkout the branches
+      - name: Fetch the PR base branch too
         run: |
           git fetch --depth=1 origin ${{ github.event.pull_request.base.ref }}
           git branch _base FETCH_HEAD
-          git fetch --depth=1 origin ${{ github.ref }}
-          git branch _head FETCH_HEAD
+          echo PR_BASE_SHA=$(git rev-parse _base) >> $GITHUB_ENV
 
-      - name: Setup asv
+      - name: Install Nox
         run: |
-          pip install asv
-          cd benchmarks
-          asv machine --yes
+          pip install nox
 
-      - name: Run benchmarks on source and target
-        run: |
-          cd benchmarks
-          asv continuous --factor 1.2 _base _head
-
-      - name: Write a compare file to the output folder
-        if: ${{ always() }}
+      - name: Cache .nox and .asv/env directories
+        id: cache-env-dir
+        uses: actions/cache@v2
+        with:
+          path: |
+            .nox
+            benchmarks/.asv/env
+          # Make sure GHA never gets an exact cache match by using the unique
+          #  github.sha. This means it will always store this run as a new
+          #  cache (Nox may have made relevant changes during run). Cache
+          #  restoration still succeeds via the partial restore-key match.
+          key: ${{ runner.os }}-${{ github.sha }}
+          restore-keys: ${{ runner.os }}
+
+      - name: Run CI benchmarks
         run: |
-          cd benchmarks
-          asv compare -s _base _head > .asv/compare.txt
+          mkdir --parents benchmarks/.asv
+          nox --session="benchmarks(ci compare)" | tee benchmarks/.asv/ci_compare.txt
 
       - name: Archive asv results
         if: ${{ always() }}
@@ -45,4 +50,4 @@ jobs:
           name: asv-report
           path: |
             benchmarks/.asv/results
-            benchmarks/.asv/compare.txt
+            benchmarks/.asv/ci_compare.txt

benchmarks/asv.conf.json

@@ -3,15 +3,18 @@
     "project": "scitools-iris",
     "project_url": "https://github.com/SciTools/iris",
     "repo": "..",
-    "environment_type": "conda-lock",
+    "environment_type": "nox-conda",
     "show_commit_url": "http://github.com/scitools/iris/commit/",
 
     "benchmark_dir": "./benchmarks",
     "env_dir": ".asv/env",
     "results_dir": ".asv/results",
     "html_dir": ".asv/html",
-    "plugins": [".conda_lock_plugin"],
-    // this is not an asv standard config entry, just for our plugin
-    // path to lockfile, relative to project base
-    "conda_lockfile": "requirements/ci/nox.lock/py38-linux-64.lock"
+    "plugins": [".nox_asv_plugin"],
+    // The commit to checkout to first run Nox to set up the environment.
+    "nox_setup_commit": "HEAD",
+    // The path of the noxfile's location relative to the project root.
+    "noxfile_rel_path": "noxfile.py",
+    // The ``--session`` arg to be used with ``--install-only`` to prep an environment.
+    "nox_session_name": "tests"
 }