jbang-catalog icon indicating copy to clipboard operation
jbang-catalog copied to clipboard

Add workflow to update examples in `README.md`

Open koppor opened this issue 7 months ago • 8 comments

Fixes https://github.com/jbangdev/jbang-catalog/issues/43

koppor avatar May 23 '25 14:05 koppor

Good idea! Btw, instead of giving two examples perhaps you could add just one plus the command to list the others instead? jbang catalog list jbangdev

Edit: although what we should actually do is create a GitHub action that on each change to the catalog file runs jbang catalog2readme@jbangdev and updates the README :-)

quintesse avatar May 23 '25 15:05 quintesse

Thank you for the neat idea! I put it on my SkedPal TODO List and it will eventually show up 😅.

koppor avatar May 30 '25 09:05 koppor

Side track: I am confused with https://github.com/jbanghub/jbang-catalog and this repository. But it is how it is... Same naming across different organizations is nice. Only have troubles with GitHub forks, because I forked both - to get https://github.com/jbanghub/jbang-catalog/pull/3 into the main catalog :)

koppor avatar Jun 06 '25 07:06 koppor

Added the workflow. Works:

grafik

Rendered example here: https://github.com/koppor/jbang-catalog-1#jbang-catalog

koppor avatar Jun 06 '25 07:06 koppor

@quintesse May I ask for some time to look into this PR?

koppor avatar Jun 12 '25 21:06 koppor

Steps to update README.md:

  1. Merge this workflow in
  2. Trigger it manually

After that on each update of the catalog json, there will be a new commit udpating README.md

koppor avatar Jun 12 '25 22:06 koppor

sorry for missing this - but this seems similar to what got merged to update readme.md, right?

maxandersen avatar Nov 11 '25 10:11 maxandersen