Refactor and rename this GH Action to be fully AsyncAPI CLI based

derberg commented 1 year ago

When I worked on this action some time ago, my main motivation was:

provide GH action for generator
do it by using Generator as library because:
- we have automated releases (for node projects) implemented in AsyncAPI organization, so I knew that whenever new Generator is released, it will trigger release of this action to also support latest release
- because wanted to use Generator as library in production and figure how that works 🤷🏼

Now times are different 😄

I think it would be better:

release 3.0 version of the action
rename action from Generator for AsyncAPI documents to Generator, validator, converter and others - all in one for your AsyncAPI docs
rename repository from github-action-for-generator to github-action-for-asyncapi-cli
throw away all the Nodejs code and modify docker file to simply expose the AsyncAPI CLI interface - example GH Action that does it https://github.com/gaurav-nelson/github-action-markdown-link-check

Or: Or we just archive this repo and create action directly in AsyncAPI CLI - example how a friend does it (CLI and GH action for it in one repo) https://github.com/mszostok/codeowners-validator. I think it makes sense, especially that in ourcase GH Action would anyway always reflect the CLI version. Current action we would just archive, set as deprecated and link to the new one.

Thoughts?

christianrowlands commented 1 year ago

Great summary of the options.

Creating the action directly in the CLI repo does sound the best, as long as the action does not get lost in all the other CLI documentation. Google searching made it easy to find this repo. Hopefully that would still work if you migrated it.

github-actions[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

derberg commented 1 year ago

still needed

github-actions[bot] commented 10 months ago

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

derberg commented 10 months ago

Let's do it in 2 steps:

first do all refactor/rename here
discuss if we can/should move to CLI

derberg commented 10 months ago

current scope:

release 3.0 version of the action
rename action from Generator for AsyncAPI documents to Generator, validator, converter and others - all in one for your AsyncAPI docs
rename repository from github-action-for-generator to github-action-for-asyncapi-cli
throw away all the Nodejs code and modify docker file to simply expose the AsyncAPI CLI interface - example GH Action that does it https://github.com/gaurav-nelson/github-action-markdown-link-check
we still need a lot of custom action parameters, like template or others
good docs explanation with examples of different configurations, like validating in one step and generating in another one
tests that make sure action works (might be that some JS code will stay to facilitate testing)

Shurtu-gal commented 10 months ago

Hey @derberg, can I work on this?

mhmohona commented 10 months ago

I want to work on this issue.

sambhavgupta0705 commented 9 months ago

@derberg I would like to work on this one as I have experience of working with GH so I think I will be able to resolve this one

aeworxet commented 9 months ago

Bounty Issue's End Of Life (EOL): 2024-02-29 23:59:59 UTC-12:00

codingmickey commented 9 months ago

Hi I would love to work on this! I've had worked with gh actions in the past extensively :)

derberg commented 9 months ago

In this issue I'll go with @Shurtu-gal that already contributed in AsyncAPI organization a number of GitHub-actions related improvements. Ashish also know AsyncaPI CLI already very well and this GH Action work involves it big time.

This is an advanced issue and I prefer to select someone who has initial knowledge and understanding of our complex setup.

aeworxet commented 9 months ago

Bounty Issue's Timeline

Complexity Level	Assignment date (by GitHub)	Start date (by BP rules)	End date (by BP rules)	Draft PR submission	Final PR submission	Final PR merge
Advanced	2023-11-13	2023-11-20	2024-01-12	2023-12-08	2023-12-29	2024-01-12

Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.

Shurtu-gal commented 9 months ago

we still need a lot of custom action parameters, like template or others.

@derberg as we would be exposing the cli interface directly, should I take parameters as a json and pass them unto cli in docker or something else. As the CLI has various topics and subtopics inside of it further down.

OR are we only looking for specific functions for now?

aeworxet commented 9 months ago

Due to unpredicted circumstances that could not be foreseen and are beyond the control of the AsyncAPI Maintainer (@derberg), the Bounty Issue's Timeline is frozen for an indefinite amount of time.

aeworxet commented 8 months ago

AsyncAPI Maintainer (@derberg) had regained a confident online presence in Slack, so the Bounty Issue's Timeline is extended by four weeks.

Bounty Issue's Timeline Extended

Complexity Level	Assignment date (by GitHub)	Start date (by BP rules)	End date (by BP rules)	Draft PR submission	Final PR submission	Final PR merge
Advanced	2023-11-13	2023-11-20	2024-02-09	2024-01-05	2024-01-26	2024-02-09

Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.

aeworxet commented 8 months ago

@asyncapi/bounty_team

aeworxet commented 7 months ago

AsyncAPI Maintainer (@derberg) was absent online in Slack for one period of three working days in a row, so all target dates of the Bounty Issue's Timeline are extended by two calendar weeks.

Bounty Issue's Timeline Extended

Complexity Level	Assignment date (by GitHub)	Start date (by BP rules)	End date (by BP rules)	Draft PR submission	Final PR submission	Final PR merge
Advanced	2023-11-13	2023-11-20	2024-02-23	2024-01-19	2024-02-09	2024-02-23

Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.

derberg commented 7 months ago

@aeworxet bounty completed like a pro 💪🏼 you can go ahead and instruct @Shurtu-gal how to get the payment

aeworxet commented 7 months ago

Bounty Issue Completed 🎉

Please go to the AsyncAPI's OpenCollective page and submit an invoice for USD 400.00 with the subject Bounty github-action-for-generator#281, tag bounty.

asyncapi / github-action-for-cli