nrkno/Github action - Autodoc
Update readme with workflow and action docs.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| workflow_file | Path to the workflow or action file to document example workflow: `.github/workflows/plan.yaml` example action: `action.yaml` | yes | .github/workflows/plan.yaml |
| doc_file | Path to the markdown file to update with documentation example: README.md | yes | README.md |
| start_token | Token marking the start of the autodoc section default value: <!-- autodoc start --> | no | <!-- autodoc start --> |
| end_token | Token marking the end of the autodoc section | no | <!-- autodoc end --> |
| table | Format inputs as a markdown table | no | true |
| debug | Print debug messages. 0=none, 1=some, 2=more, 3=all | no | 0 |
Outputs
| name | description |
|---|---|
| file_type | The type automaticly detected by the script of the input_file documented: workflow or action |
| autodoc_out | If enabled, the generated documentation for inputs, secrets, and outputs |