tj-actions/auto-doc
Document your github action or reusable workflow with ease
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| filename | Path to the yaml file | no | action.yml |
| col_max_width | Max width of a column | no | 1000 |
| col_max_words | Max number of words per line in a column | no | 5 |
| output | Path to the output file | no | README.md |
| bin_path | Optionally pass a path to the auto-doc binary | no | — |
| input_columns | List of action.yml **input** columns names to display, default (display all columns) | no | — |
| output_columns | List of action.yml **output** column names to display, default (display all columns) | no | — |
| reusable_output_columns | List of reusable workflow **output** column names to display, default (display all columns) | no | — |
| reusable_input_columns | List of reusable workflow **input** column names to display, default (display all columns) | no | — |
| reusable_secret_columns | List of reusable workflow **secret** column names to display, default (display all columns) | no | — |
| reusable | Boolean Indicating whether the file is a reusable workflow | no | — |
| version | The version number to run | no | — |
| markdown_links | Boolean indicating whether to output input, output and secret names as markdown links | no | true |
| repository | Repository name with owner. For example, tj-actions/auto-doc | no | ${{ github.repository }} |
| token | GitHub token or Personal Access Token used to fetch the repository latest tag. | no | ${{ github.token }} |
| use_code_blocks | Enable code block documentation | no | false |
| use_major_version | Use the major version of the repository tag e.g v1.0.0 -> v1 | no | false |
| use_tag_commit_hash | Use the tag commit hash as the version and add a comment with the tag name. Example: v1.0.0 -> 1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p7q8r9s0t // v1.0.0 or v1 | no | false |
Outputs
no outputs