feat: Trigger on opened PR, ready for review or sourcery-review label
#6
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # 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 pull request is opened in non-draft state | |
| # - a pull request is moved from draft to ready for review | |
| # - 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 | |
| - opened | |
| - ready_for_review | |
| - 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 PR is opened in non draft state, | |
| # is moved from draft to ready for review, | |
| # or the "sourcery-review" label is added to the pull request. | |
| if: | | |
| github.event.action == 'opened' && !github.event.pull_request.draft || | |
| github.event.action == 'ready_for_review' || | |
| 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 }} |