Switch to jinja2 for generating CI yamls (#2534)

The current approach was becoming hard to maintain. This should make it easier to integrate new frameworks.
getsentry · Nov 28, 2023 · c025ffe · c025ffe
1 parent 12b8f98
commit c025ffe
Show file tree

Hide file tree

Showing 54 changed files with 605 additions and 1,536 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -44,6 +44,7 @@ jobs:
           python-version: 3.12
 
       - run: |
+          pip install jinja2
           python scripts/split-tox-gh-actions/split-tox-gh-actions.py --fail-on-changes
 
   build_lambda_layer:

diff --git a/.github/workflows/test-common.yml b/.github/workflows/test-common.yml
@@ -1,33 +1,26 @@
 name: Test common
-
 on:
   push:
     branches:
       - master
       - release/**
-
   pull_request:
-
 # Cancel in progress workflows on pull_requests.
 # https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-a-fallback-value
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
-
 permissions:
   contents: read
-
 env:
   BUILD_CACHE_KEY: ${{ github.sha }}
   CACHED_BUILD_PATHS: |
     ${{ github.workspace }}/dist-serverless
-
 jobs:
-  test:
-    name: common, python ${{ matrix.python-version }}, ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
+  test-pinned:
     timeout-minutes: 30
-
+    name: common pinned, python ${{ matrix.python-version }}, ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
@@ -37,17 +30,14 @@ jobs:
         # ubuntu-20.04 is the last version that supported python3.6
         # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877
         os: [ubuntu-20.04]
-
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-
       - name: Setup Test Env
         run: |
           pip install coverage "tox>=3,<4"
-
       - name: Test common
         uses: nick-fields/retry@v2
         with:
@@ -58,30 +48,24 @@ jobs:
           command: |
             set -x # print commands that are executed
             coverage erase
-
             # Run tests
             ./scripts/runtox.sh --exclude-latest "py${{ matrix.python-version }}-common" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch &&
             coverage combine .coverage* &&
             coverage xml -i
-
       - uses: codecov/codecov-action@v3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: coverage.xml
-
   test-py27:
-    name: common, python 2.7, ubuntu-20.04
+    timeout-minutes: 30
+    name: common py27, python 2.7
     runs-on: ubuntu-20.04
     container: python:2.7
-    timeout-minutes: 30
-
     steps:
       - uses: actions/checkout@v4
-
       - name: Setup Test Env
         run: |
           pip install coverage "tox>=3,<4"
-
       - name: Test common
         uses: nick-fields/retry@v2
         with:
@@ -92,22 +76,23 @@ jobs:
           command: |
             set -x # print commands that are executed
             coverage erase
-
             # Run tests
             ./scripts/runtox.sh --exclude-latest "py2.7-common" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch &&
             coverage combine .coverage* &&
             coverage xml -i
-
-
+      - uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage.xml
   check_required_tests:
     name: All common tests passed or skipped
-    needs: [test, test-py27]
+    needs: [test-pinned, test-py27]
     # Always run this, even if a dependent job failed
     if: always()
     runs-on: ubuntu-20.04
     steps:
       - name: Check for failures
-        if: contains(needs.test.result, 'failure')
+        if: contains(needs.test-pinned.result, 'failure')
         run: |
           echo "One of the dependent jobs has failed. You may need to re-run it." && exit 1
       - name: Check for 2.7 failures

diff --git a/.github/workflows/test-integration-aiohttp.yml b/.github/workflows/test-integration-aiohttp.yml
@@ -1,33 +1,26 @@
 name: Test aiohttp
-
 on:
   push:
     branches:
       - master
       - release/**
-
   pull_request:
-
 # Cancel in progress workflows on pull_requests.
 # https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-a-fallback-value
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
-
 permissions:
   contents: read
-
 env:
   BUILD_CACHE_KEY: ${{ github.sha }}
   CACHED_BUILD_PATHS: |
     ${{ github.workspace }}/dist-serverless
-
 jobs:
-  test:
-    name: aiohttp, python ${{ matrix.python-version }}, ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
+  test-pinned:
     timeout-minutes: 30
-
+    name: aiohttp pinned, python ${{ matrix.python-version }}, ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
@@ -37,17 +30,14 @@ jobs:
         # ubuntu-20.04 is the last version that supported python3.6
         # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877
         os: [ubuntu-20.04]
-
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-
       - name: Setup Test Env
         run: |
           pip install coverage "tox>=3,<4"
-
       - name: Test aiohttp
         uses: nick-fields/retry@v2
         with:
@@ -58,23 +48,18 @@ jobs:
           command: |
             set -x # print commands that are executed
             coverage erase
-
             # Run tests
             ./scripts/runtox.sh --exclude-latest "py${{ matrix.python-version }}-aiohttp" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch &&
             coverage combine .coverage* &&
             coverage xml -i
-
       - uses: codecov/codecov-action@v3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: coverage.xml
-
-
   test-latest:
+    timeout-minutes: 30
     name: aiohttp latest, python ${{ matrix.python-version }}, ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
-    timeout-minutes: 30
-
     strategy:
       fail-fast: false
       matrix:
@@ -84,17 +69,14 @@ jobs:
         # ubuntu-20.04 is the last version that supported python3.6
         # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877
         os: [ubuntu-20.04]
-
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-
       - name: Setup Test Env
         run: |
           pip install coverage "tox>=3,<4"
-
       - name: Test aiohttp
         uses: nick-fields/retry@v2
         with:
@@ -105,25 +87,22 @@ jobs:
           command: |
             set -x # print commands that are executed
             coverage erase
-
             # Run tests
             ./scripts/runtox.sh "py${{ matrix.python-version }}-aiohttp-latest" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch &&
             coverage combine .coverage* &&
             coverage xml -i
-
       - uses: codecov/codecov-action@v3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: coverage.xml
-
   check_required_tests:
     name: All aiohttp tests passed or skipped
-    needs: test
+    needs: test-pinned
     # Always run this, even if a dependent job failed
     if: always()
     runs-on: ubuntu-20.04
     steps:
       - name: Check for failures
-        if: contains(needs.test.result, 'failure')
+        if: contains(needs.test-pinned.result, 'failure')
         run: |
           echo "One of the dependent jobs has failed. You may need to re-run it." && exit 1
diff --git a/.github/workflows/test-integration-ariadne.yml b/.github/workflows/test-integration-ariadne.yml
@@ -1,33 +1,26 @@
 name: Test ariadne
-
 on:
   push:
     branches:
       - master
       - release/**
-
   pull_request:
-
 # Cancel in progress workflows on pull_requests.
 # https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-a-fallback-value
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
-
 permissions:
   contents: read
-
 env:
   BUILD_CACHE_KEY: ${{ github.sha }}
   CACHED_BUILD_PATHS: |
     ${{ github.workspace }}/dist-serverless
-
 jobs:
-  test:
-    name: ariadne, python ${{ matrix.python-version }}, ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
+  test-pinned:
     timeout-minutes: 30
-
+    name: ariadne pinned, python ${{ matrix.python-version }}, ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
@@ -37,17 +30,14 @@ jobs:
         # ubuntu-20.04 is the last version that supported python3.6
         # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877
         os: [ubuntu-20.04]
-
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-
       - name: Setup Test Env
         run: |
           pip install coverage "tox>=3,<4"
-
       - name: Test ariadne
         uses: nick-fields/retry@v2
         with:
@@ -58,23 +48,18 @@ jobs:
           command: |
             set -x # print commands that are executed
             coverage erase
-
             # Run tests
             ./scripts/runtox.sh --exclude-latest "py${{ matrix.python-version }}-ariadne" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch &&
             coverage combine .coverage* &&
             coverage xml -i
-
       - uses: codecov/codecov-action@v3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: coverage.xml
-
-
   test-latest:
+    timeout-minutes: 30
     name: ariadne latest, python ${{ matrix.python-version }}, ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
-    timeout-minutes: 30
-
     strategy:
       fail-fast: false
       matrix:
@@ -84,17 +69,14 @@ jobs:
         # ubuntu-20.04 is the last version that supported python3.6
         # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877
         os: [ubuntu-20.04]
-
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-
       - name: Setup Test Env
         run: |
           pip install coverage "tox>=3,<4"
-
       - name: Test ariadne
         uses: nick-fields/retry@v2
         with:
@@ -105,25 +87,22 @@ jobs:
           command: |
             set -x # print commands that are executed
             coverage erase
-
             # Run tests
             ./scripts/runtox.sh "py${{ matrix.python-version }}-ariadne-latest" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch &&
             coverage combine .coverage* &&
             coverage xml -i
-
       - uses: codecov/codecov-action@v3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: coverage.xml
-
   check_required_tests:
     name: All ariadne tests passed or skipped
-    needs: test
+    needs: test-pinned
     # Always run this, even if a dependent job failed
     if: always()
     runs-on: ubuntu-20.04
     steps:
       - name: Check for failures
-        if: contains(needs.test.result, 'failure')
+        if: contains(needs.test-pinned.result, 'failure')
         run: |
           echo "One of the dependent jobs has failed. You may need to re-run it." && exit 1