Skip to content

github-action-readme-generator 1.1.6 Latest

This is a CLI tool and GitHub Action that reads in the details from a GitHub Action's `action.yml` file and updates the `README.md` file with the `name`, `description`, `usage`, `inputs`, `outputs`, and examples of the action. Configuration can be provided via a `.ghadocs.json` file stored in the root directory of the Action's repository, via the command line when using the cli, or via the `with:` section of this Action. This tool uses markdown comments as delimiting tokens within the `README.md` file to determine where to place the generated content. [`README.example.md`](README.example.md) example with all fields filled in, and no other free-form content.

Install from the command line:
Learn more about npm packages
$ npm install @bitflight-devops/github-action-readme-generator@1.1.6
Install via package.json:
"@bitflight-devops/github-action-readme-generator": "1.1.6"

Recent Versions

  • 1.1.6
    Latest
    Published over 3 years ago
    0
  • Published almost 4 years ago
    1
  • Published almost 4 years ago
    0

Loading

Details


Last published

over 3 years ago

Issues

9

Total downloads

1


Contributors 9