chore: migrate github-action to cli

.gitignore

@@ -20,6 +20,9 @@ asyncapi.yml
 test/fixtures/minimaltemplate/__transpiled
 .vscode
 
+/action/
+/github-action/output/
+
 oclif.manifest.json
 spec-examples.zip
 

action.yml

@@ -0,0 +1,54 @@
+name: 'Generator, Validator, Converter and others - all in one for your AsyncAPI docs'
+description: 'Use this action to generate docs or code from your AsyncAPI document. Use default templates or provide your custom ones.'
+inputs:
+  cli_version: 
+    description: 'Version of AsyncAPI CLI to be used. This is only needed if you want to test with a specific version of AsyncAPI CLI. Default is latest which is also the recommended option.'
+    required: false
+    default: ''
+  command:
+    description: 'Command to run. Available commands in action :- generate, validate, convert, optimize and custom. Default is generate. For custom command, provide the whole command as input. List of available commands can be found in https://www.asyncapi.com/docs/tools/cli/usage.'
+    required: false
+    default: 'generate'
+  filepath:
+    description: 'Path to AsyncAPI document. This input is required if command is set to generate, validate, convert or optimize. Default is ./asyncapi.yaml'
+    required: false
+    default: 'asyncapi.yml'
+  template: 
+    description: 'Template for the generator. Official templates are listed here https://github.com/search?q=topic%3Aasyncapi+topic%3Agenerator+topic%3Atemplate. You can pass template as npm package, url to git repository, link to tar file or local template.'
+    default: '@asyncapi/[email protected]'
+    required: false
+  language:
+    description: 'Language of the generated code. This input is required if you want to generate models. List of available languages can be found in https://www.asyncapi.com/docs/tools/cli/usage#asyncapi-generate-models-language-file'
+    required: false
+    default: ''
+  output:
+    description: 'Directory where to put the generated files. Can be used only with generate or convert commands. Default is output.'
+    required: false
+    default: 'output'
+  parameters: 
+    description: 'The command that you use might support and even require specific parameters to be passed to the CLI for the generation. Template parameters should be preceded by -p'
+    required: false
+    default: ''
+  custom_command:
+    description: 'Custom command to be run. This input is required if command is set to custom.'
+    required: false
+    default: ''
+
+runs:
+  using: 'docker'
+  # This is the image that will be used to run the action. 
+  # IMPORTANT: The version has to be changed manually in your PRs.
+  image: 'docker://asyncapi/github-action-for-cli:3.1.2'
+  args:
+    - ${{ inputs.cli_version }}
+    - ${{ inputs.command }}
+    - ${{ inputs.filepath }}
+    - ${{ inputs.template }}
+    - ${{ inputs.language }}
+    - ${{ inputs.output }}
+    - ${{ inputs.parameters }}
+    - ${{ inputs.custom_command }}
+
+branding:
+  icon: 'file-text'
+  color: purple

github-action/.asyncapi-tool

@@ -0,0 +1,6 @@
+title: GitHub Action for Generator
+filters:
+    technology:
+        - AsyncAPI Generator
+    categories:
+        - github-actions

github-action/Dockerfile

@@ -0,0 +1,38 @@
+FROM node:18-alpine
+
+# Create a non-root user
+RUN addgroup -S myuser && adduser -S myuser -G myuser
+
+# Install necessary packages
+RUN apk add --no-cache bash git chromium
+
+# Environment variables for Puppeteer
+ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true
+ENV PUPPETEER_EXECUTABLE_PATH=/usr/bin/chromium-browser
+
+FROM ubuntu:latest
+
+# Copy the asyncapi directory
+COPY tmp/asyncapi/ /asyncapi
+
+# Create a script that runs the desired command
+RUN echo "#!/bin/bash\n/asyncapi/bin/run" > /usr/local/bin/asyncapi
+
+# Make the script executable
+RUN chmod +x /usr/local/bin/asyncapi
+
+RUN ls -l /usr/local/bin/asyncapi
+
+# Change ownership to non-root user
+RUN chown -R myuser:myuser /asyncapi /usr/local/bin/asyncapi || echo "Failed to change ownership"
+
+# Copy the entrypoint script
+COPY github-action/entrypoint.sh /entrypoint.sh
+
+# Make the entrypoint script executable
+RUN chmod +x /entrypoint.sh
+
+FROM node:18-alpine 
+
+# Set the entrypoint
+ENTRYPOINT ["/entrypoint.sh"]

github-action/Makefile

@@ -0,0 +1,61 @@
+DEFAULT_VERSION = 'latest'
+DEFAULT_COMMAND = 'generate'
+TEST_FILEPATH = 'test/asyncapi.yml'
+DEFAULT_TEMPLATE = '@asyncapi/[email protected]'
+DEFAULT_LANGUAGE = ''
+DEFAULT_OUTPUT = 'output'
+DEFAULT_PARAMETERS = ''
+DEFAULT_CUSTOM_COMMANDS = ''
+CUSTOM_COMMANDS = 'validate test/asyncapi.yml'
+
+# Add env variables to the shell
+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) 
+
+test: test-default test-validate-success test-custom-output test-custom-commands test-optimize test-bundle test-convert test-action-bump
+
+# Test cases
+
+# Tests if the action has been bumped greater than the latest release
+test-action-bump:
+	@bash bump-test.sh
+
+# Tests the default configuration without any inputs
+test-default:
+	@bash ./entrypoint.sh $(DEFAULT_VERSION) $(DEFAULT_COMMAND) $(TEST_FILEPATH) $(DEFAULT_TEMPLATE) $(DEFAULT_LANGUAGE) $(DEFAULT_OUTPUT) $(DEFAULT_PARAMETERS) $(DEFAULT_CUSTOM_COMMANDS) 
+
+# Tests the validate command with a valid specification
+test-validate-success:
+	@bash ./entrypoint.sh $(DEFAULT_VERSION) 'validate' $(TEST_FILEPATH) $(DEFAULT_TEMPLATE) $(DEFAULT_LANGUAGE) $(DEFAULT_OUTPUT) $(DEFAULT_PARAMETERS) $(DEFAULT_CUSTOM_COMMANDS) 
+
+# Tests the validate command with an invalid specification
+test-validate-fail:
+	@bash ./entrypoint.sh $(DEFAULT_VERSION) 'validate' './test/specification-invalid.yml' $(DEFAULT_TEMPLATE) $(DEFAULT_LANGUAGE) $(DEFAULT_OUTPUT) $(DEFAULT_PARAMETERS) $(DEFAULT_CUSTOM_COMMANDS) 
+
+# Tests if the generator can output to a custom directory
+test-custom-output:
+	@bash ./entrypoint.sh $(DEFAULT_VERSION) $(DEFAULT_COMMAND) $(TEST_FILEPATH) $(DEFAULT_TEMPLATE) 'typescript' './output/custom-output' $(DEFAULT_PARAMETERS) $(DEFAULT_CUSTOM_COMMANDS) 
+
+# Tests if the action prefers custom commands over the default command
+test-custom-commands:
+	@bash ./entrypoint.sh $(DEFAULT_VERSION) $(DEFAULT_COMMAND) $(TEST_FILEPATH) $(DEFAULT_TEMPLATE) 'typescript' './output/custom-output' $(DEFAULT_PARAMETERS) $(CUSTOM_COMMANDS) 
+
+# Tests if the action fails when the input is invalid (e.g. invalid template as is the case here) 
+fail-test:
+	@bash ./entrypoint.sh $(DEFAULT_VERSION) $(DEFAULT_COMMAND) $(TEST_FILEPATH) '' $(DEFAULT_LANGUAGE) $(DEFAULT_OUTPUT) $(DEFAULT_PARAMETERS) $(DEFAULT_CUSTOM_COMMANDS) 
+
+# Tests if the action optimizes the specification
+test-optimize:
+	@bash ./entrypoint.sh $(DEFAULT_VERSION) 'optimize' 'test/unoptimized.yml' $(DEFAULT_TEMPLATE) $(DEFAULT_LANGUAGE) $(DEFAULT_OUTPUT) '-o new-file --no-tty' $(DEFAULT_CUSTOM_COMMANDS)
+
+# Tests if the action can bundle the specification with custom commands
+BUNDLE_COMMAND='bundle ./test/bundle/asyncapi.yaml ./test/bundle/features.yaml --base ./test/bundle/asyncapi.yaml -o ./output/bundle/asyncapi.yaml'
+test-bundle:
+	mkdir -p ./output/bundle
+	@bash ./entrypoint.sh $(DEFAULT_VERSION) 'bundle' 'test/bundle/asyncapi.yaml' $(DEFAULT_TEMPLATE) $(DEFAULT_LANGUAGE) $(DEFAULT_OUTPUT) '-o output/bundle/asyncapi.yaml' $(BUNDLE_COMMAND)
+
+# Tests if the action can convert the specification with custom commands
+test-convert:
+	@bash ./entrypoint.sh $(DEFAULT_VERSION) 'convert' 'test/asyncapi.yml' $(DEFAULT_TEMPLATE) $(DEFAULT_LANGUAGE) 'output/convert/asyncapi.yaml' '' $(DEFAULT_CUSTOM_COMMANDS)