test.yml

name: test

on:
  push:
    branches:
      - master
  pull_request:
  workflow_dispatch:

concurrency:
  group: ${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python-version: ['3.8', '3.9', '3.10', '3.11']

    steps:
    - uses: actions/checkout@v3
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v4
      with:
        python-version: ${{ matrix.python-version }}

    - name: Install poetry
      run: |
        curl -sSL "https://install.python-poetry.org" | python

        # Adding `poetry` to `$PATH`:
        echo "$HOME/.poetry/bin" >> $GITHUB_PATH

    - name: Install dependencies
      run: |
        poetry config virtualenvs.in-project true
        poetry run pip install -U pip
        poetry install

    - name: Run tests
      run: make test

    - name: Upload coverage to Codecov
      uses: codecov/codecov-action@v3
      with:
        file: ./coverage.xml

  remark-lint:
    name: remark-lint
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3

    - name: Setup Node
      uses: actions/setup-node@v3
      with:
        node-version: '16'

    - name: Install remark presets
      run: |
        npm install remark \
          remark-cli \
          remark-lint \
          remark-lint-code-block-style \
          remark-lint-no-empty-url \
          remark-lint-no-tabs \
          remark-preset-lint-consistent \
          remark-preset-lint-markdown-style-guide \
          remark-preset-lint-recommended \
          remark-validate-links

    - name: Create config file
      run: |
        cat << EOF > .remarkrc
        {
          "plugins": [
            "lint",
            "lint-no-tabs",
            "lint-no-empty-url",
            "lint-code-block-style",
            [
              "lint-unordered-list-marker-style",
              "-"
            ],
            "validate-links",
            "remark-preset-lint-recommended",
            [
              "lint-list-item-indent",
              "space"
            ],
            "preset-lint-consistent"
          ]
        }
        EOF

    - name: remark-lint
      uses: reviewdog/action-remark-lint@v5
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        fail_on_error: true
        remark_args: --rc-path=.remarkrc
        filter_mode: nofilter
        reporter: github-pr-check