bitflight-devops/GitHub Action's Readme Generator
📓 The docs generator for GitHub Actions. Auto-syncs action.yml → README.md with 8 sections including inputs, outputs, usage, badges & branding. Sensible defaults, highly configurable.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| action | The absolute or relative path to the `action.yml` file to read in from. | no | action.yml |
| readme | The absolute or relative path to the markdown output file that contains the formatting tokens within it. | no | README.md |
| owner | The GitHub Action repository owner, this field is autodetected by default. Example: `bitflight-devops` or `your-gh-username` | no | — |
| repo | The GitHub Action repository name, this field is autodetected by default. Example: `github-action-readme-generator` | no | — |
| save | Save the provided values in a `.ghadocs.json` file. This will update any existing `.ghadocs.json` file that is in place. | no | false |
| pretty | Use `prettier` to pretty print the new README.md file | no | true |
| versioning_enabled | Enable the update of the usage version to match the latest version in the `package.json` file Output if your action repo is `reviewdog/action-eslint` and version in package.json is `1.0.1`: `uses: reviewdog/action-eslint@1.0.1` | no | true |
| version_override | Set a specific version to display in the README.md, maybe you want to use a major or minor version | no | — |
| version_prefix | Prefix the version with this value, if it isn't already prefixed | no | v |
| versioning_default_branch | If versioning is disabled, use this branch in the usage example, where the default is `main` Output if your action repo is `reviewdog/action-eslint`: `uses: reviewdog/action-eslint@main` | no | main |
| version_source | How to detect the action version for the usage example. Options: - `git-tag` - Latest git tag (default, standard for GitHub Actions) - `git-branch` - Current branch name (for bleeding edge users) - `git-sha` - Current commit SHA (for exact pinning) - `package-json` - Read from package.json version field - `explicit` - Use value from `version_override` input only | no | git-tag |
| title_prefix | Add a prefix to the README title. The title template looks like this: # {brand}{prefix}{title} | no | GitHub Action: |
| include_github_version_badge | Include additional badge showing latest tag | no | true |
| branding_svg_path | Create the branding svg image from the branding object in `action.yml` then save it to this path. Then update the `README.md` file to source the branding image from this path. You can use a section template like this: `<!-- start branding --><!-- stop branding -->` or use the action input: `branding_as_title_prefix: true` to prefix the 'title' section with the image. The title template looks like this: # {brand}{prefix}{title} | no | .github/ghadocs/branding.svg |
| branding_as_title_prefix | Prefix the title in the `<!-- start title -->` section with the svg branding image The title template looks like this: # {brand}{prefix}{title} | — | true |
Outputs
| name | description |
|---|---|
| sections | A json object containing a map of section names to their new content |
| readme | The path to the generated README.md file |
| readme_before | The content of the readme file before the changes were made |
| readme_after | The content of the readme file after the changes were made |