Skip to content

Add workflow to update examples in README.md#44

Open
koppor wants to merge 5 commits intojbangdev:mainfrom
koppor:patch-1
Open

Add workflow to update examples in README.md#44
koppor wants to merge 5 commits intojbangdev:mainfrom
koppor:patch-1

Conversation

@koppor
Copy link
Contributor

@koppor koppor commented May 23, 2025

Fixes #43

@quintesse
Copy link
Contributor

quintesse commented May 23, 2025

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 :-)

@koppor koppor marked this pull request as draft May 30, 2025 09:32
@koppor
Copy link
Contributor Author

koppor commented May 30, 2025

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

@koppor
Copy link
Contributor Author

koppor commented Jun 6, 2025

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 jbanghub/jbang-catalog#3 into the main catalog :)

@koppor
Copy link
Contributor Author

koppor commented Jun 6, 2025

Added the workflow. Works:

grafik

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

@koppor koppor marked this pull request as ready for review June 12, 2025 21:36
@koppor
Copy link
Contributor Author

koppor commented Jun 12, 2025

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

Copy link
Contributor

@quintesse quintesse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@koppor
Copy link
Contributor Author

koppor commented Jun 12, 2025

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

@maxandersen
Copy link
Contributor

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

@koppor
Copy link
Contributor Author

koppor commented Dec 24, 2025

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

Title misleading. This adds a workflow updating the README. No manual updates required anymore.

@koppor koppor changed the title Add examples to README.md Add workflow to update examples in README.md Dec 24, 2025
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 this pull request may close these issues.

Add howto use

3 participants