GitHub actions file Documenter

What is this

This is a Command line tool to automatically document (With minimal input) GitHub actions workflow files

Quick start

Install

go install github.com/userbradley/actions-documenter@latest

Create Configuration file

curl -o readme.hcl https://raw.githubusercontent.com/userbradley/actions-documenter/main/example/readme.hcl

Create quickstart file

mkdir docs
touch docs/quickstart.md

In this file you should put the minimum viable product to get it working.

Dynamically render the version

You can replace the version (so @v1.0.0) with ${{version}} so when the command line tool is run, it will find and replace so you don't need to update it everywhere when releasing a new version

Create a single example

Now create an example in the example folder on how to use the action in a specific way and update the configuration file