action.yml

name: format-rst-files-action
description: 'A GitHub Action to format RST files using rstfmt'
branding:
  icon: file-text
  color: white
inputs:
  rstfmt-args:
    description: 'Additional arguments to pass to rstfmt.'
    required: false
    default: ''
  files:
    description: 'Pattern to match the RST files to be formatted.'
    required: false
    default: '**/*.rst'
  commit:
    description: 'Whether or not you want the action to push to your repo with the formatting.'
    required: false
    default: 'true'
  github-username:
    description: 'Username for the GitHub action to commit with.'
    required: false
    default: 'github-actions'
  commit-message:
    description: 'Message for the formatter commit.'
    required: false
    default: 'Format RST files'
runs:
  using: node16
  main: 'build/index.js'