github-action-readme

Bootstrap a README for your GitHub Actions by reading action.yml and providing events that the action responds to.

Usage

npx github-action-readme ./action.yml --event pull_request --actions opened,reopened,synchronize,labeled,closed --token=github > README.md

You can pass --token=github to use secrets.GITHUB_TOKEN or --token=pat to add information on how to generate a Personal Access token.

See the examples folder for a set of READMEs generated with this tool

Name		Name	Last commit message	Last commit date
Latest commit History 1 Commit
examples		examples
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
bin.js		bin.js
choose-event.js		choose-event.js
index.js		index.js
package-lock.json		package-lock.json
package.json		package.json