Add matrix job to ci.yml to reduce conflicts (#263)

Author: Cadair

cookiecutter.json

@@ -29,6 +29,7 @@
     "include_example_code": "n",
     "include_cruft_update_github_workflow": "n",
     "use_extended_ruff_linting": "n",
+    "matrix_room_id": "",
     "_sphinx_theme": "sunpy",
     "_parent_project": "",
     "_install_requires": "",
@@ -44,6 +45,7 @@
         "download_url": "PyPI address for the project, optional",
         "documentation_url": "Documentation URL, optional",
         "changelog_url": "URL to the changelog, optional",
-        "issue_tracker_url": "URL to the issue tracker, optional"
+        "issue_tracker_url": "URL to the issue tracker, optional",
+        "matrix_room_id": "A room ID to enable matrix notifications in the CI workflow."
     }
 }

tests/conftest.py

@@ -79,6 +79,7 @@ def bake_examples(cookies):
             "author_name": "test",
             "use_extended_ruff_linting": "y",
             "issue_tracker_url": "https://github.com/sunpy/sunpy/issues",
+            "matrix_room_id": "!example:matrix.org",
         }
     )
     return _handle_cookiecutter_errors(result)

{{ cookiecutter.package_name }}/.github/workflows/ci.yml

@@ -137,3 +137,22 @@ jobs:
 
       - name: Run upload
         uses: pypa/gh-action-pypi-publish@v1.13.0  # zizmor: ignore[unpinned-uses]
+
+{% if cookiecutter.matrix_room_id -%}
+  notify:
+    if: {{ "${{ !cancelled() && (github.event_name == 'workflow_dispatch' || github.event_name == 'schedule') }}" }}
+    needs: [build_dists]
+    runs-on: ubuntu-latest
+    environment:
+      name: matrix
+    steps:
+      - uses: Cadair/matrix-notify-action@main  # zizmor: ignore[unpinned-uses]
+        with:
+          workflow_description: "CI Workflow"
+          matrix_token: {{ '${{ secrets.MATRIX_ACCESS_TOKEN }}' }}
+          github_token: {{ '${{ secrets.GITHUB_TOKEN }}' }}
+          homeserver: {{ '${{ secrets.MATRIX_HOMESERVER }}' }}
+          roomid: '{{ cookiecutter.matrix_room_id }}'
+          ignore_pattern: '.*(Load|report overall).*'
+          summarise_success: true
+{%- endif %}