From e5dd98113bbd7a08b39cd608948151d26e7bc85b Mon Sep 17 00:00:00 2001
From: Brendan Maginnis <brendan@sourcery.ai>
Date: Tue, 14 Nov 2023 14:41:34 +0000
Subject: [PATCH] feat: Add sourcery assistant review workflow (#1)

---
 .github/workflows/sourcery_code_review.yaml | 63 +++++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 .github/workflows/sourcery_code_review.yaml

diff --git a/.github/workflows/sourcery_code_review.yaml b/.github/workflows/sourcery_code_review.yaml
new file mode 100644
index 0000000..b7e706b
--- /dev/null
+++ b/.github/workflows/sourcery_code_review.yaml
@@ -0,0 +1,63 @@
+# Perform a code review on a pull request using the Sourcery Coding Assistant.
+
+name: Sourcery Coding Assistant Review
+
+on:
+  # Trigger the review on pull request events.
+  pull_request:
+    types:
+    # Trigger the review when either of these events occur:
+    #
+    # - a review is requested from any user
+    # - the "sourcery-review" label is added to the pull request: add this label
+    #   to your pull request to trigger a review. To re-request reviews, remove the
+    #   label and add it again.
+    #
+    # Feel free to edit this list to suit your team's needs. See the list of all
+    # activity types here:
+    # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request
+    - review_requested
+    - labeled
+
+permissions:
+  # Read the contents of the repository
+  contents: read
+  # Create a pull request review
+  pull-requests: write
+
+jobs:
+  sourcery-coding-assistant-review:
+    # Only run this job when a review is requested or the "sourcery-review"
+    # label is added to the pull request.
+    if: |
+      github.event.action == 'review_requested' ||
+        github.event.label.name == 'sourcery-review'
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Install Sourcery
+        shell: bash
+        # Install the latest nightly version of Sourcery from PyPI.
+        # This gives you access to the latest features and bug fixes.
+        # To install the latest stable version, use `pip install sourcery`.
+        run: |
+          pip install --pre sourcery-nightly
+
+      - name: Log into Sourcery
+        shell: bash
+        # Log into Sourcery using the Sourcery token stored in the SOURCERY_TOKEN GitHub
+        # secret.
+        run: |
+          sourcery login \
+            --token ${{ secrets.SOURCERY_TOKEN }}
+
+      - name: Run Sourcery code review
+        # Run the Sourcery code review on the pull request that triggered this workflow.
+        shell: bash
+        run: |
+          sourcery assistant review pull-request \
+            --token ${{ github.token }} \
+            --repository ${{ github.repository }} \
+            --pull-request ${{ github.event.pull_request.number }} \
+            --commit ${{ github.event.pull_request.head.sha }}