Additionally the Action's usage example is updated to match the Action's current release.

This is a CLI tool and GitHub Action that reads the details from a GitHub Action's action.yml file. It updates the README.md file with the name, description, usage, inputs, outputs, and examples of the action. Configuration can be provided through a .ghadocs.json file stored in the root directory of the Action's repository, via the command line when using the CLI, or through 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.

🔗 You can find an example with all fields filled in, and no other free-form content, in the README.example.md file.

CLI Usage

Stand Alone Usage - if you have a Docker Action

npx --yes github-action-readme-generator@latest

Install with Yarn or NPM as a dev dependency

yarn add -D github-action-readme-generator
# or
npm i --save-dev github-action-readme-generator

Add a script to your project file

You can modify the script below to include any extra variables you like or use none, and instead use a .ghadocs.json file.

{
  "scripts": {
    "ghadocs": "github-action-readme-generator --readme README.md && git add README.md"
  }
}

Configuration

Example .ghadocs.json with all possible values

{
  "paths": {
    "action": "action.yml",
    "readme": "README.md"
  },
  "show_logo": true,
  "versioning": {
    "enabled": true,
    "override": "",
    "prefix": "v",
    "branch": "main"
  },
  "owner": "bitflight-devops",
  "repo": "github-action-readme-generator",
  "title_prefix": "GitHub Action: ",
  "pretty": true
}

TODO

• Add section for a title to the generator
• Add section for a description to the generator
• Add word wrapping to multi-line text
• Add section to generate the action.yml inputs to a table to the generator
• Add section to generate the action.yml outputs to a table to the generator
• Add a markdown contents menu section to the generator
• Allow for using a separate template for generating the readme file
• Add section to embed other markdown files or directories by path, so that documentation can be organized in the file system.
  i.e., <!-- start [.github/ghadocs/examples/] --> and <!-- end [.github/ghadocs/examples/] -->

Usage

• uses: bitflight-devops/github-action-readme-generator@v1.5.1 with:

  Default: action.yml

  action: ''

  Default: README.md

  readme: ''

  owner: ''

  repo: ''

  save: ''

  pretty: ''

  versioning_enabled: ''

  version_override: ''

  Default: v

  version_prefix: ''

  Default: main

  versioning_default_branch: ''

  Default: GitHub Action:

  title_prefix: ''

  Default: true

  include_github_version_badge: ''

<!-- end usage -->

## Inputs

<!-- start inputs -->| ****Input**** | ****Description**** | ****Default**** | ****Required**** |
|---|---|---|---|
| `**action**` | The absolute or relative path to the `action.yml` file to read in from. | `action.yml` | __false__ |
| `**readme**` | The absolute or relative path to the markdown output file that contains the formatting tokens within it. | `README.md` | __false__ |
| `**owner**` | The GitHub Action repository owner. i.e: `bitflight-devops`\|`your-gh-username` |  | __false__ |
| `**repo**` | The GitHub Action repository name. i.e: `github-action-readme-generator` |  | __false__ |
| `**save**` | Save the provided values in a `.ghadocs.json` file. This will update any existing `.ghadocs.json` file that is in place. |  | __false__ |
| `**pretty**` | Use `prettier` to pretty print the new README.md file |  | __false__ |
| `**versioning_enabled**` | Enable the update of the usage version to match the latest version in the `package.json` file |  | __false__ |
| `**version_override**` | Set a specific version to display in the README.md |  | __false__ |
| `**version_prefix**` | Prefix the version with this value (if it isn't already prefixed) | `v` | __false__ |
| `**versioning_default_branch**` | If versioning is disabled show this branch instead | `main` | __false__ |
| `**title_prefix**` | Add a prefix to the README title | `GitHub Action: ` | __false__ |
| `**include_github_version_badge**` | Include additional badge showing latest tag | `true` | __false__ |
<!-- end inputs -->
<!-- start outputs -->
<!-- end outputs -->
<!-- start [.github/ghadocs/examples/] -->
<!-- end [.github/ghadocs/examples/] -->