action-docs ☆
« Back to VersTracker
Description:
Generate docs for GitHub actions
Type: Formula  |  Latest Version: 2.5.1@0  |  Tracked Since: Dec 17, 2025
Links: Homepage  |  formulae.brew.sh
Category: Devops
Tags: github-actions documentation cli devops automation
Install: brew install action-docs
About:
Action-docs is a command-line utility that automatically generates documentation for GitHub Actions. It parses action metadata from action.yml or action.yaml files and produces formatted output in Markdown or JSON. This streamlines the process of keeping repository documentation in sync with action inputs, outputs, and branding.
Key Features:
  • Parses action.yml and action.yaml files to extract metadata
  • Outputs documentation in Markdown or JSON formats
  • Supports custom templates for flexible documentation generation
  • Integrates easily into CI/CD pipelines for automated updates
Use Cases:
  • Automatically updating action README files in repositories
  • Generating standardized documentation for public marketplace actions
  • Maintaining up-to-date docs as part of a CI workflow
Alternatives:
  • act – Act runs GitHub Actions locally; it does not generate documentation.
  • actionlint – Actionlint lints workflows; it is not designed for generating action docs.
Version History
Detected Version Rev Change Commit
Nov 10, 2024 3:04pm 0 VERSION_BUMP a67abbd2
Nov 10, 2024 2:38pm 0 VERSION_BUMP 5cfeae41
« Back to VersTracker  |  Browse Packages  |  About