format_rst.yml

name: RST Autoformatter

on: [push, pull_request]

jobs:
  formatting:
    runs-on: ubuntu-latest
    steps:
      - name: Check out code
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.10'

      - name: Run RST Autoformatter
        uses: CodeByAidan/rst-autoformatter-action@main
        with:
          # files: '**/*.rst' # works! - globbing is supported
          # files: 'tests/*.rst' # works! - just another glob patterns
          # files: 'tests/lines.rst' # works! - single file
          # files: '{tests/admonitions,tests/escaped-text}.rst' # works! - brace expansion is supported (Unix trick)
          # For more patterns, see https://mywiki.wooledge.org/glob#Globs
          files: '**/*.rst'
          commit: 'true'
          github-username: 'github-actions'
          commit-message: 'Automated RST formatting'