Generates documentation from your GitHub Action's action.yml
| Name | Description | Required | Default |
|---|---|---|---|
| template-filename | The path to the ERB template to use to generate the documentation. | No | |
| output-filename | The filename to save the output to. If not specified, simply prints to standard output. | No | |
| path-to-action-yml | The path to the action.yml file to generate documentation for. If not specified, assumes action.yml. |
No | |
| working-directory | The directory to perform the action in, if not $GITHUB_WORKSPACE | No |
actiondoc is both a Ruby Gem and a GitHub Action that uses that gem to generate a suitable README.md from
an optional ERB template, intended to help keep your own action's documentation up-to-date with the actual inputs.
See Basic Usage for some basic usage of the gem.
Given an action.yml that contains:
name: actiondoc
description: >-
Generates documentation from your GitHub Action's `action.yml`
inputs:
path-to-action-yml:
description: >-
The path to the `action.yml` file
required: falseThen when running actiondoc it should output
actiondoc
====
Generates documentation from your GitHub Action's `action.yml`
## Inputs
| Name | Description | Required | Default |
|--------------------|-----------------------------------|----------|---------|
| path-to-action-yml | The path to the `action.yml` file | No | |The following sample workflow uses this repository as a GitHub Action directly, and commits the updated README.md directly.
name: Generate README
on:
push:
paths:
- action.yml
- README.md.erb
jobs:
generate-readme:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- run: if [ -f README.md ]; then rm README.md; fi
- name: Generate README
uses: aisrael/actiondoc@v2
with:
template-filename: README.md.erb
output-filename: README.md
- run: |
cat README.md
- name: Commit & Push changes
uses: actions-js/push@master
with:
github_token: ${{ secrets.GITHUB_TOKEN }}The following sample workflow uses this repository as a GitHub Action directly, and creates a PR (using
peter-evans/create-pull-request) to
update README.md on any changes to either action.yml or README.md.erb.
name: Generate README
on:
push:
paths:
- action.yml
- README.md.erb
jobs:
generate-readme:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- run: if [ -f README.md ]; then rm README.md; fi
- name: Generate README
uses: aisrael/actiondoc@v2
with:
template-filename: README.md.erb
output-filename: README.md
- run: |
cat README.md
- name: Create Pull Request
uses: peter-evans/create-pull-request@v4
with:
add-paths: README.md
base: main
branch: update-readme
delete-branch: true
title: Update README.md