Create allure reports in CI

.github/workflows/ci.yml

@@ -59,7 +59,15 @@ jobs:
       - run: poetry install --no-root --all-extras
       - run: poe lint
       - run: poe build-develop
-      - run: poe test -s -o log_cli_level=DEBUG
+      - run: poe test -s --alluredir allure-results-${{ matrix.python }}-${{ matrix.os }} -o log_cli_level=DEBUG
+      - name: "Allure: upload artifact"
+        uses: actions/upload-artifact@master
+        if: always()
+        with:
+          # TODO: handle matrix build structure with allure
+          name: allure-results-${{ matrix.python }}-${{ matrix.os }}
+          path: allure-results-${{ matrix.python }}-${{ matrix.os }}
+          retention-days: 30
       # Time skipping doesn't yet support ARM
       - if: ${{ !endsWith(matrix.os, '-arm') }}
         run: poe test -s -o log_cli_level=DEBUG --workflow-environment time-skipping
@@ -111,3 +119,52 @@ jobs:
       version: ${{github.event.pull_request.head.ref}}
       version-is-repo-ref: true
       features-repo-ref: python-update-updates
+
+  # https://allurereport.org/docs/integrations-github/
+  # This must be a separate job since it uses container actions that are linux-only.
+
+  create-allure-report:
+    name: "Allure: load previous history, create report, and publish"
+    needs: build-lint-test
+    if: always()
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ["3.8", "3.12"]
+        os: [ubuntu-latest, ubuntu-arm, macos-intel, macos-arm, windows-latest]
+        exclude:
+          - os: macos-arm
+            python: "3.8"
+    steps:
+      - name: "Allure: Download Artifacts"
+        uses: actions/download-artifact@v3
+        id: download
+        with:
+          path: allure-results-${{ matrix.python }}-${{ matrix.os }}
+          name: allure-results
+
+      - name: "Allure: load test report history"
+        uses: actions/checkout@v4
+        if: always()
+        continue-on-error: true
+        with:
+          ref: gh-pages
+          path: allure-report-data-${{ matrix.python }}-${{ matrix.os }}
+
+      - name: "Allure: build test report"
+        uses: simple-elf/[email protected]
+        if: always()
+        with:
+          gh_pages: allure-report-data-${{ matrix.python }}-${{ matrix.os }}
+          allure_results: allure-results
+          allure_history: allure-history-${{ matrix.python }}-${{ matrix.os }}
+
+      - name: "Allure: publish test report"
+        if: always()
+        uses: Wandalen/wretry.action@master
+        with:
+          action: peaceiris/actions-gh-pages@v4
+          with: |
+            github_token: ${{ secrets.GITHUB_TOKEN }}
+            publish_branch: gh-pages
+            publish_dir: allure-history-${{ matrix.python }}-${{ matrix.os }}

pyproject.toml

@@ -41,6 +41,7 @@ types-protobuf = ">=3.20"
 typing-extensions = "^4.2.0"
 
 [tool.poetry.dev-dependencies]
+allure-pytest = "^2.13.5"
 cibuildwheel = "^2.19.0"
 grpcio-tools = "^1.48.0"
 mypy = "^1.0.0"