GitHub Action
Generator, Validator, Converter and others - all in one for your AsyncAPI docs
This action generates whatever you want using your AsyncAPI document. It uses AsyncAPI Generator.
Template for the generator. Official templates are listed here https://github.com/asyncapi/generator#list-of-official-generator-templates. You can pass template as npm package, url to git repository, link to tar file or local template.
Default points to @asyncapi/[email protected] template.
We recommend to always specify the version of the template to not encounter any issues with the action in case of release of the template that is not compatible with given version of the generator.
Location of the AsyncAPI document.
Default expects asyncapi.yml in the root of the working directory.
The template that you use might support and even require specific parameters to be passed to the template for the generation.
Directory where to put the generated files.
Default points to output directory in the working directory.
In case all defaults are fine for you, just add such step:
- name: Generating Markdown from my AsyncAPI document
uses: docker://asyncapi/github-action-for-generator:2.0.0In 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-generator:2.0.0
with:
template: '@asyncapi/[email protected]' #In case of template from npm, because of @ it must be in quotes
filepath: docs/api/my-asyncapi.yml
parameters: baseHref=/test-experiment/ sidebarOrganization=byTags #space separated list of key/values
output: generated-htmlIn case you want to validate your asyncapi file first, and also send generated HTML to GitHub Pages this is how full workflow could look like:
name: AsyncAPI documents processing
on:
push:
branches: [ master ]
jobs:
generate:
runs-on: ubuntu-latest
steps:
#"standard step" where repo needs to be checked-out first
- name: Checkout repo
uses: actions/checkout@v2
#Using another action for AsyncAPI for validation
- name: Validating AsyncAPI document
uses: WaleedAshraf/asyncapi-github-action@v1
with:
filepath: docs/api/my-asyncapi.yml
#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-generator:2.0.0
with:
template: '@asyncapi/[email protected]' #In case of template from npm, because of @ it must be in quotes
filepath: docs/api/my-asyncapi.yml
parameters: baseHref=/test-experiment/ sidebarOrganization=byTags #space separated list of key/values
output: generated-html
#Using another action that takes generated HTML and pushes it to GH Pages
- name: Deploy GH page
uses: JamesIves/[email protected]
with:
ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages
FOLDER: generated-htmlYou can enable more log information in GitHub Action by adding ACTIONS_STEP_DEBUG secret to repository where you want to use this action. Set the value of this secret to true and you''ll notice more debug logs from this action.