Generate Markdown from Action Inputs

This GitHub Action automatically generates a Markdown table of your action's inputs and adds it to your README.md. It's a simple way to keep your documentation in sync with your action.yml file.

Why use this action?

• Automated Documentation: No more manually updating your README.md every time you change an input in your action.yml.
• Improved Discoverability: A clear and concise table of inputs makes it easier for users to understand and use your action.
• Professional Look: A well-documented action is a sign of a quality project.

Before and After

Before:

<!-- ACTION-INPUT-LIST:START -->
<!-- ACTION-INPUT-LIST:END -->
Copy

After:

<!-- ACTION-INPUT-LIST:START -->

| Name       | Default         | Description               | Required |
| ---------- | --------------- | ------------------------- | -------- |
| `my-input` | `default-value` | This is my amazing input. | `false`  |

<!-- ACTION-INPUT-LIST:END -->
Copy

Usage

1. Add the comment block to your README.md:

   Add the following comment block to your README.md where you want the table of inputs to be generated:

   <!-- ACTION-INPUT-LIST:START -->
   <!-- ACTION-INPUT-LIST:END -->
   Copy

2. Create a workflow file:

   Create a new workflow file in your .github/workflows directory (e.g., .github/workflows/docs.yml) with the following content:

example-generate-md-action-inputs.yml

name: generate-md-action-inputs example
on:
    workflow_dispatch:
permissions:
    actions: write
    contents: write
jobs:
    release:
        runs-on: ubuntu-latest
        steps:
            - uses: actions/checkout@v4
            - uses: actions/setup-node@v4
            - uses: stephansama/actions/generate-md-action-inputs@v1
              with:
                  verbose: true
Copy

Required permissions

permissions:
    actions: write
    contents: write
Copy

⚙️ Inputs