https://github.com/npalm/action-docs-action

Action to update GitHub action documentation
https://github.com/npalm/action-docs-action

action actions docs-generator

Last synced: about 2 months ago
JSON representation

Action to update GitHub action documentation

• Host: GitHub
• URL: https://github.com/npalm/action-docs-action
• Owner: npalm
• License: mit
• Created: 2021-02-21T13:03:55.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-09-30T06:25:18.000Z (3 months ago)
• Last Synced: 2024-10-04T16:37:35.494Z (3 months ago)
• Topics: action, actions, docs-generator
• Language: TypeScript
• Homepage:
• Size: 1.76 MB
• Stars: 13
• Watchers: 3
• Forks: 9
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        


  



# Action to update GitHub Action documentation

This action wraps [action-docs](https://github.com/npalm/action-docs) to update action and workflow documentation. By default the action will update `README.md` based on the `action.yml`. See the parameters for changing the defaults.

## Usage

The action will update your readme by replacing html comment tags. Add one of more tags based on the following template to your repo:  `` to add the corresponding section.

- `header` : to add/update a header based on the name of the action/workflow (only added if action option `includeNameHeader` is set to true)

- `description` : to add/update a section with a descriptions of the action (applicable to actions only)

- `inputs`: to add/update a section with inputs of the action/workflow

- `outputs`: to add/update a section with outputs of the action/workflow

- `runs`: to add/update a section of the environment required to run (applicable to actions only)

- `usage`: to add/update a section containing an example of how to call the action/workflow. This comment also requires passing a project and a version to use in the example e.g. ``.

- `all`: to include all of the above in order

In your workflow add the action, see below for the available parameters.

```yaml

      - uses: npalm/action-docs-action

```

The action will not commit any change, to ensure the changes are persisted you can use an action to [commit](https://github.com/stefanzweifel/git-auto-commit-action) or raise a [pull request](https://github.com/peter-evans/create-pull-request).

## Inputs

| name | description | required | default |

| --- | --- | --- | --- |

| `readme` | 
Readme file to update.
 | `false` | `README.md` |

| `actionFile` | 
The action definition file.
Deprecated: This input is replaced by sourceFile
 | `false` | `""` |

| `sourceFile` | 
The action or workflow definition file.
 | `false` | `action.yml` |

| `includeNameHeader` | 
Include the name header in the updated readme.
 | `false` | `true` |

| `tocLevel` | 
TOC level used for the headers. The includeNameHeader input is influecing the TOC level, setting includeNameHeader to true will increase the TOC level by 1.
 | `false` | `2` |

| `lineBreaks` | 
Line breaks to be used in updated readme (LF, CR or CRLF).
 | `false` | `LF` |


## Runs

This action is a `node20` action.

## License

This project are released under the [MIT License](./LICENSE).