Automate generation of README tables

[YuviGold]

The README tables of the catalog of CLIs and apps might become out of sync from time to time. It should be automatically generated and fail build in case not committed.

Expected Behaviour

Any new CLI / app to the catalog automatically updates arkade help messages and it should update the static files as well. i.e. https://github.com/alexellis/arkade/blob/master/README.md

Current Behaviour

The https://github.com/alexellis/arkade/blob/master/README.md gets out-of-sync and requires manual updates.

Are you a GitHub Sponsor yet (Yes/No?)

• [ ] Yes
• [x] No

Possible Solution

Generation of static files using https://nedbatchelder.com/code/cog/

Context

Making this repository more automated

Your Environment

• What arkade version is this?

arkade version
            _             _      
  __ _ _ __| | ____ _  __| | ___ 
 / _` | '__| |/ / _` |/ _` |/ _ \
| (_| | |  |   < (_| | (_| |  __/
 \__,_|_|  |_|\_\__,_|\__,_|\___|

Open Source Marketplace For Developer Tools

Version: 0.8.32
Git Commit: b004f9adb0f90c89ef1440f988685fd6b6111d3f

 🐳 arkade needs your support, learn more: https://my.arkade.dev

[alexellis]

Hi @YuviGold

Thanks for your interest here

As usual, all issues require approval from a maintainer before we can consider a technical solution.

Alex

[YuviGold]

Closed the PR https://github.com/alexellis/arkade/pull/737 till deciding on the technical solution.

The solution needs to support:

• Generation script needs to run with the latest binary (in order to get latest changes, using bin binary)
• Running the script as part of the CI in order to verify it wasn't missed
• Making the script deterministic

[Jasstkn]

Maybe move table generation to a separate file then execute generation command/script and use git to define if there is a diff?