proselint.yml

name: Proselint Check
on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
permissions:
  contents: read
jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - name: Check out the code
        uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.x'
      - name: Install Proselint
        run: |
          python -m pip install --upgrade pip
          pip install proselint
      - name: Run Proselint on Markdown files
        run: |
          # Find all Markdown files and pass them to Proselint
          files=$(find . -name "*.md")
          if [ -n "$files" ]; then
            proselint $files
          else
            echo "No Markdown files found to lint."
          fi
        continue-on-error: false # Set to true if you want to allow warnings without failing
      - name: Upload Proselint report
        if: failure()
        run: |
          echo "Proselint found issues in the following files:"
          find . -name "*.md" -exec proselint {} \; || echo "No issues found."