github-action-for-cli icon indicating copy to clipboard operation
github-action-for-cli copied to clipboard

Shift the GitHub action to CLI repository

Open Shurtu-gal opened this issue 8 months ago • 19 comments

Why do we need this improvement?

Currently the versions, releases and other stuff are isolated from CLI which is directly coupled with this CLI. However, this creates problems in bumping of versions and keeping code updated as well.

Furthermore, any change in CLI spec could be easily made here as well.

How will this change help?

This will help in automation of releases of CLI and tie them together properly.

How could it be implemented/designed?

This issue can be resolved through the following steps:-

  • Transfer the source code of this action in a github-action folder.
  • Put the test workflow in its proper place in .github directory.
  • Tie the version at these steps: https://github.com/asyncapi/github-action-for-cli/blob/590180ca0d91785af367276558b2b60d86f7d1e2/entrypoint.sh#L29 https://github.com/asyncapi/github-action-for-cli/blob/590180ca0d91785af367276558b2b60d86f7d1e2/Dockerfile#L13
  • Add automation for release of new version of action with bump in CLI version.
  • Put action.yml in root folder.

Additional steps:

  1. Instead of installing the asyncapi cli, dockerise the code from parent directory itself.

[!IMPORTANT] The action and bump of version would need to be tested in your personal repo or account. From my past experience would suggest using an alternate account itself.

🚧 Breaking changes

Yes

Shurtu-gal avatar Jun 14 '24 19:06 Shurtu-gal