gharga

Github Actions README CLI-generator

Generate Github actions and workflow documentation.

Usage

Install the cli

npm install gharga

Get help (gharga --help)

Usage: gharga [options] <workflow>

A CLI GH-Actions-Readme-Generator

Arguments:
  workflow           Workflow file

Options:
  -v, --version      output the version number
  -o, --output-file  path where to write the output file
  -h, --help         display help for command

Render Readme file for a workflow

To generate a documentation for .github/workflows/01-with-choice.yaml, run the following command

gharga .github/workflows/01-with-choice.yaml

This will render the following

# 01-Example: Another action with choices

## Usage

### Dispatch

| Name        | Type   | Description                                                                   | Required  | default     | deprecationMessage |
| ----------- | ------ | ----------------------------------------------------------------------------- | --------- | ----------- | ------------------ |
| **isNight** | choice | I will say good night if this value is set to "yes" (possible values: yes,no) | **true**  | *``*        | -                  |
| **name**    | string | Name to greet                                                                 | **false** | *`Octocat`* | -                  |

License

MIT