https://github.com/pr-annotators/template-pr-annotator

Annotate pull requests with {tool-name} errors detected during CI
https://github.com/pr-annotators/template-pr-annotator

Last synced: 2 months ago
JSON representation

Annotate pull requests with {tool-name} errors detected during CI

• Host: GitHub
• URL: https://github.com/pr-annotators/template-pr-annotator
• Owner: pr-annotators
• License: mit
• Created: 2022-03-31T17:44:31.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-03-31T17:48:49.000Z (about 4 years ago)
• Last Synced: 2025-07-28T19:35:47.724Z (10 months ago)
• Homepage:
• Size: 1.95 KB
• Stars: 2
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# {tool-name} PR Annotator

## Usage

Annotate pull requests with {tool-name} errors detected during CI.

Note: This doesn't install or run {tool-name}, it just sets up the PR annotations.

### Example workflow

```yaml

name: My Workflow

on: [push, pull_request]

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@master

      - name: Set up Python 3.8

        uses: actions/setup-python@v2

        with:

          python-version: "3.8"

        

      - name: Install {tool-name}

        run: |

          pip install {tool-name}

      - name: Add {tool-name} annotator

        uses: jpy-git/{tool-name}-pr-annotator@master

      - name: Run {tool-name}

        run: |

          {tool-name} src/

```