asyncapi / github-action-for-cli

GitHub Action with generator, validator, converter and others - all in one for your AsyncAPI documents with AsyncAPI CLI as backbone
Apache License 2.0
45 stars 19 forks source link

feat!: refactor action to be CLI based #348

Closed Shurtu-gal closed 7 months ago

Shurtu-gal commented 9 months ago

Description

The PR changes the GitHub action from being just a generator to an all-in-one tool.

What's New:

Changes Made

Breaking Changes:

Previously, the parameter option was exclusive to template parameters. It has now been expanded to apply to all commands. Therefore, users must now add -p before template params for the same functionality.

Things left

Related issue(s) Fixes #281

Shurtu-gal commented 8 months ago

I will take out the config approach and keep it simple. Same with cli_version too.

Shurtu-gal commented 8 months ago

@derberg README is also updated

aeworxet commented 8 months ago

@asyncapi/bounty_team

Shurtu-gal commented 8 months ago

I have added the test workflow. @derberg Sample workflow can be found here

Shurtu-gal commented 7 months ago

@derberg The requested changes have been added. Regarding sonarcloud hotspot, I had made the changes to fix it but it led to permission issues when making docker container for GitHub action as can be seen in the run here

derberg commented 7 months ago

@Shurtu-gal please bring back the user settings in dockerfile and simply silent sonar by adding https://github.com/asyncapi/cli/blob/master/.sonarcloud.properties file to this repo, just adjust it to ignore dockerfile, and add comment why we ignore it: that this docker file is for starting containers that should run only in GitHub Actions and no other environments, and running with security violation is ok

Shurtu-gal commented 7 months ago

Done @derberg.

sonarcloud[bot] commented 7 months ago

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

derberg commented 7 months ago

works well on my side

because we know there is one potential breaking change in case of parameters field, and that -p needs to be used, I added ! to the title so we release this new version as new major

derberg commented 7 months ago

/rtm

derberg commented 7 months ago

@allcontributors please add @Shurtu-gal for code,test,doc,ideas,maintainance

allcontributors[bot] commented 7 months ago

@derberg

I've put up a pull request to add @Shurtu-gal! :tada: