Skip to content

Commit

Permalink
Update the version of html template and asyncapi generator for the Gi…
Browse files Browse the repository at this point in the history
…tHub action
  • Loading branch information
christianrowlands committed Dec 4, 2023
1 parent b941e4c commit b140f44
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/doc_generate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ 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-generator:2.1.13
uses: docker://asyncapi/github-action-for-generator:2.1.17
with:
template: '@asyncapi/html-template@1.0.0' #In case of template from npm, because of @ it must be in quotes
template: '@asyncapi/html-template@2.0.0' #In case of template from npm, because of @ it must be in quotes
filepath: src/main/asyncapi/network_survey_messaging.yaml
#parameters: baseHref=/test-experiment/ sidebarOrganization=byTags #space separated list of key/values
output: generated-html
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Additional AsyncAPI generators can be found here: https://github.com/asyncapi/g
There is also an option to use a docker container for running the AsyncAPI commands instead of running locally. More information
can be found [here](https://www.npmjs.com/package/@asyncapi/generator#cli-usage-with-docker).

An example command: `docker run --rm -it -v ${PWD}/src/main/asyncapi/network_survey_messaging.yaml:/app/network_survey_messaging.yaml -v ${PWD}/docs:/app/output asyncapi/generator:1.14.1 /app/network_survey_messaging.yaml @asyncapi/html-template@1.0.0 -o /app/output --force-write`
An example command: `docker run --rm -it -v ${PWD}/src/main/asyncapi/network_survey_messaging.yaml:/app/network_survey_messaging.yaml -v ${PWD}/testdocs:/app/output asyncapi/generator:1.15.1 /app/network_survey_messaging.yaml @asyncapi/html-template@2.0.0 -o /app/output --force-write`

#### Building the HTML content from the AsyncAPI file
- Execute `ag src/main/asyncapi/network_survey_messaging.yaml @asyncapi/html-template -o build/network-survey-messaging-html`
Expand Down

0 comments on commit b140f44

Please sign in to comment.