GitHub Action
PR annotator with ruff
v0.1.20
Latest version
Warning
Archived because now ruff does this by default. Check its docs: https://docs.astral.sh/ruff/integrations/#github-actions
It runs ruff
against pull requests changed lines, and creates a review comment with them.
name: 'Dependency Review'
on: [pull_request]
jobs:
dependency-review:
runs-on: ubuntu-latest
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so that annotate_pr_with_ruff can access it.
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Install dependencies library
run: |
pip install ruff
shell: bash
- name: annotate_pr_with_ruff
uses: EnriqueSoria/annotate_pr_with_ruff@c226a0b09f7e8ea7f148f29c129f89399b37f03d
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
For the installation of ruff
there are two options possible:
- Using install-pinned, which is safer
- name: Install ruff from install-pinned action
uses: install-pinned/ruff@66c987de12929f701b73e83c82edc36050ae55a0 # Specify a version
- Using pip without specifying a version, which will ensure you have always the same version
- name: Install ruff from pypi
run: |
pip install ruff
Here's an screenshot of what it can do:
I've used typilus/typilus-action as a template for creating this action, which is MIT Licensed.