proselint.yml

# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.

name: proselint

'on':
  push:
    branches:
      - master
      - '*/ci'
  pull_request:
    branches:
      - master

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
  cancel-in-progress: true

permissions: {}

jobs:
  check:
    name: 'check'
    runs-on: ubuntu-24.04-arm
    steps:
      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
        with:
          persist-credentials: false

      - name: install prereqs
        run: |
          sudo find /etc/apt/sources.list.d -type f -not -name 'ubuntu.sources' -delete -print
          sudo apt-get -o Dpkg::Use-Pty=0 update
          sudo apt-get -o Dpkg::Use-Pty=0 install \
            python3-proselint

      - name: trim off quoted parts
        run: find . -name "*.md" -print0 | xargs -0 -n1 .github/scripts/cleanmd.pl

      # config file help: https://github.com/amperser/proselint/
      - name: store proselint config
        run: |
          {
            echo '{'
            echo '   "checks": {'
            echo '     "typography.diacritical_marks": false,'
            echo '     "typography.symbols": false,'
            echo '     "annotations.misc": false'
            echo '   }'
            echo '}'
          } > $HOME/.proselintrc.json

      - name: check prose
        run: make check