name: Generate Action Docs

on: [pull_request]

jobs:
  doc:
    runs-on: ubuntu-latest

    permissions:
      # Required to push changes!
      contents: write

    steps:
    - uses: actions/checkout@v3
      with:
        # Required to push changes!
        ref: ${{ github.event.pull_request.head.ref }}

    - uses: pndurette/gh-actions-auto-docs@v1

# [...]

inputs:
  param1:
    description: This param has some **bold** and *italics*
    required: true
    default: value1
  param2:
    description: |
      Path to some yaml:

      \```yaml
      foo: bar
      baz:
        - abc
      \```

      :warning: **Some cautionnary `tale`!**
    required: false
    default: ./some_file.yaml
  param3:
    description: See [link to somewhere](https://github.com)

outputs:
  output1:
    description: |
      A list to consider:
      1. This
      2. That
  output2:
    description: |
      Someone once said:

      > Hello, how do you do?
  output3:
    description: This is it

# [...]