Generate documentation for your actions.(yml|yaml).
Add the Inputs and/or Outputs H2 header to any markdown file
...
steps:
- uses: actions/checkout@v2
- name: Run auto-doc
uses: tj-actions/[email protected]| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| action | string | false | "action.yml" |
Path to the action.yml file |
| col_max_width | string | false | "1000" |
Max width of a column |
| col_max_words | string | false | "5" |
Max number of words per line in a column |
| output | string | false | "README.md" |
Path to the output file |
👆 This is generated 👆 using 👉 action.yml
Create a pull request each time the action.yml inputs/outputs change
name: Update README.md with the latest actions.yml
on:
push:
branches:
- main
jobs:
update-doc:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/[email protected]
with:
fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
- name: Run auto-doc
uses: tj-actions/[email protected]
- name: Verify Changed files
uses: tj-actions/[email protected]
id: verify-changed-files
with:
files: |
README.md
- name: Create Pull Request
if: steps.verify-changed-files.outputs.files_changed == 'true'
uses: peter-evans/create-pull-request@v3
with:
base: "main"
title: "auto-doc: Updated README.md"
branch: "chore/auto-doc-update-readme"
commit-message: "auto-doc: Updated README.md"
body: "auto-doc: Updated README.md"Run
go install github.com/tj-actions/auto-docRun
auto_doc --helpAuto generate documentation for your github action.
Usage:
auto-doc [flags]
Flags:
--action string action config file (default "action.yml")
--colMaxWidth string Max width of a column (default "1000")
--colMaxWords string Max number of words per line in a column (default "5")
-h, --help help for auto-doc
--output string Output file (default "README.md")- Free software: Apache License 2.0
If you feel generous and want to show some extra appreciation:
This package was created with Cookiecutter using cookiecutter-action
Report bugs at https://github.com/tj-actions/auto-doc/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your workflow that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "github-actions[bot]")
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
![renovate[bot] avatar](https://avatars.githubusercontent.com/in/2740?v=4 "renovate[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent