https://github.com/userbradley/actions-documenter

CLI tool to generate documentation for GitHub actions
https://github.com/userbradley/actions-documenter

cli documenter github-actions go

Last synced: about 2 months ago
JSON representation

CLI tool to generate documentation for GitHub actions

• Host: GitHub
• URL: https://github.com/userbradley/actions-documenter
• Owner: userbradley
• License: other
• Created: 2023-08-12T00:25:52.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-15T20:21:58.000Z (12 months ago)
• Last Synced: 2024-10-15T03:31:10.438Z (3 months ago)
• Topics: cli, documenter, github-actions, go
• Language: Go
• Homepage: https://userbradley.github.io/actions-documenter/
• Size: 1.72 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Actions Documenter

This is a simple CLI tool that allows you to automatically generate **highly opinionated** documentation with 

minimal input from the human

## Installing

```shell

git clone [email protected]:userbradley/actions-documenter.git

go install

```

## Setting up the Configuration

Create a file called `readme.hcl`

In the file put the below:

```hcl

version = "v1.0.0"

title {

  enabled = true

  override = ""

}

quickstart {

  path = "docs/quickstart.md"

}

examples {

  example {

    enabled = true

    name    = "Example 1"

    path    = "docs/example1.md"

  }

}

footer {

  footer_from = "footer.md"

}

```

### How to use the version

To make life easier and not having to update every reference for the verison, you can use `@${{version}}` in the action file

```yaml

    steps:

      - uses: userbradley/example-action@${{version}}

```

When this gets rendered out, it will be replaced with what ever `version` is set to

You should ensure that the `readme.hcl` file is in the same location as the `action.yml` file

### How to add more examples

To add more examples, just repeat the `example` block like below

```hcl

examples {

  example {

    enabled = true

    name    = "Example 1"

    path    = "docs/example1.md"

  }

  example {

    enabled = true

    name    = "Example 2"

    path    = "docs/example2.md"

  }

}

```

## Contact

As per the license, if you want to use this internally please contact me on [[email protected]](mailto:[email protected])