Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automate generation of README tables #736

Open
1 of 2 tasks
YuviGold opened this issue Aug 15, 2022 · 3 comments
Open
1 of 2 tasks

Automate generation of README tables #736

YuviGold opened this issue Aug 15, 2022 · 3 comments

Comments

@YuviGold
Copy link
Contributor

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
  • 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
Copy link
Owner

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
Copy link
Contributor Author

Closed the PR #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
Copy link
Contributor

Jasstkn commented Sep 2, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants