feat: add docker support to action directly

.releaserc

@@ -18,4 +18,10 @@ plugins:
   - preset: conventionalcommits
 - - "@semantic-release/release-notes-generator"
   - preset: conventionalcommits
-- "@semantic-release/github"
+- - "@semantic-release/exec"
+  - prepareCmd: "VERSION=${nextRelease.version} npm run bump:version"
+- - "@semantic-release/git"
+  - assets:
+    - "action.yml"
+    message: "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+- "@semantic-release/github"

Makefile

@@ -14,6 +14,12 @@ export GITHUB_WORKSPACE = $(shell pwd)
 run:
 	@bash ./entrypoint.sh $(DEFAULT_VERSION) $(DEFAULT_COMMAND) $(TEST_FILEPATH) $(DEFAULT_TEMPLATE) $(DEFAULT_LANGUAGE) $(DEFAULT_OUTPUT) $(DEFAULT_PARAMETERS) $(DEFAULT_CUSTOM_COMMANDS) 
 
+# Updates the action.yml file with the latest version of the action got from $VERSION env variable
+generate-assets:
+	version=$$(echo ${VERSION} | sed 's/v//g'); \
+	sed "s/docker:\/\/asyncapi\/github-action-for-cli:.*/docker:\/\/asyncapi\/github-action-for-cli:$$version'/g" action.yml > action.yml.tmp
+	@mv action.yml.tmp action.yml
+
 test: test-default test-validate-success test-validate-fail test-custom-output test-custom-commands test-optimize test-bundle test-convert
 
 # Test cases

README.md

@@ -41,7 +41,7 @@ Sample usage:
 
 ```yaml
 - name: Generating HTML from my AsyncAPI document
-  uses: docker://asyncapi/github-action-for-cli:2.0.0
+  uses: asyncapi/github-action-for-cli@v3.0.2 # You can use any version you want
   with:
     custom_command: bundle ./asyncapi.yaml --output final-asyncapi.yaml
 ```
@@ -91,15 +91,20 @@ The command that you use might support and even require specific parameters to b
 > [!NOTE]
 > For template parameters, you need to pass them as `-p <template_parameters>` as can be seen in CLI documentation.
 
+
 ## Example usage
 
+> [!WARNING]
+> Using `docker://asyncapi/github-action-for-cli` will not work as expected. This is because the GitHub Actions runner does not pass params to the docker image correctly. This is why we recommend to use `asyncapi/github-action-for-cli` instead.
+> However, you don't need to worry as it won't build the image every time. It will pull it from Docker Hub as it is already built there.
+
 ### Basic
 
 In case all defaults are fine for you, just add such step:
 
 ```yaml
 - name: Generating Markdown from my AsyncAPI document
-  uses: docker://asyncapi/github-action-for-cli:3.0.0
+  uses: 
 ```
 
 ### Using all possible inputs
@@ -108,7 +113,7 @@ In case you do not want to use defaults, you for example want to use different t
 
 ```yaml
 - name: Generating HTML from my AsyncAPI document
-  uses: docker://asyncapi/github-action-for-cli:3.0.0
+  uses: asyncapi/github-action-for-cli@v3.0.2 # You can use any version you want
   with:
     command: generate
     filepath: ./docs/api/asyncapi.yaml
@@ -140,7 +145,7 @@ jobs:
 
     #In case you do not want to use defaults, you for example want to use different template
     - name: Generating HTML from my AsyncAPI document
-      uses: docker://asyncapi/github-action-for-cli:3.0.0
+      uses: asyncapi/github-action-for-cli@v3.0.2 # You can use any version you want
       with:
         template: '@asyncapi/html-template@0.9.0'  #In case of template from npm, because of @ it must be in quotes
         filepath: docs/api/my-asyncapi.yml
@@ -177,7 +182,7 @@ jobs:
       uses: actions/checkout@v2
 
     - name: Generating models from my AsyncAPI document
-      uses: docker://asyncapi/github-action-for-cli:3.0.0
+      uses: asyncapi/github-action-for-cli@v3.0.2 # You can use any version you want
       with:
         command: generate
         filepath: docs/api/my-asyncapi.yml
@@ -205,7 +210,7 @@ jobs:
       uses: actions/checkout@v2
 
     - name: Validating AsyncAPI document
-      uses: docker://asyncapi/github-action-for-cli:3.0.0
+      uses: asyncapi/github-action-for-cli@v3.0.2 # You can use any version you want
       with:
         command: validate
         filepath: docs/api/my-asyncapi.yml

action.yml

@@ -36,7 +36,8 @@ inputs:
 
 runs:
   using: 'docker'
-  image: 'Dockerfile'
+  # This is the image that will be used to run the action. The version of the image is changed automatically by releasing a new version of the action.
+  image: 'docker://asyncapi/github-action-for-cli:3.0.1'
   args:
     - ${{ inputs.cli_version }}
     - ${{ inputs.command }}