Skip to content

Commit

Permalink
Update the version numbers for building the AsyncAPI docs
Browse files Browse the repository at this point in the history
  • Loading branch information
christianrowlands committed Aug 5, 2024
1 parent 236f73f commit 7587baa
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ jobs:
uses: actions/checkout@v4

- name: Validating AsyncAPI document
uses: asyncapi/[email protected].1
uses: asyncapi/[email protected].2
with:
command: validate
filepath: src/main/asyncapi/network_survey_messaging.yaml

- name: Generating HTML from my AsyncAPI document
uses: asyncapi/[email protected].1
uses: asyncapi/[email protected].2
with:
template: '@asyncapi/html-template@2.1.1' #In case of template from npm, because of @ it must be in quotes
template: '@asyncapi/html-template@2.3.9' #In case of template from npm, because of @ it must be in quotes
filepath: src/main/asyncapi/network_survey_messaging.yaml
output: generated-html
6 changes: 3 additions & 3 deletions .github/workflows/doc_and_library_release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -78,15 +78,15 @@ jobs:
ref: develop

- name: Validating AsyncAPI document
uses: asyncapi/[email protected].1
uses: asyncapi/[email protected].2
with:
command: validate
filepath: src/main/asyncapi/network_survey_messaging.yaml

- name: Generating HTML from my AsyncAPI document
uses: asyncapi/[email protected].1
uses: asyncapi/[email protected].2
with:
template: '@asyncapi/html-template@2.1.1' #In case of template from npm, because of @ it must be in quotes
template: '@asyncapi/html-template@2.3.9' #In case of template from npm, because of @ it must be in quotes
filepath: src/main/asyncapi/network_survey_messaging.yaml
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 @@ -88,7 +88,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}/builddocs:/app/output asyncapi/generator:1.17.0 /app/network_survey_messaging.yaml @asyncapi/html-template@2.1.1 -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}/builddocs:/app/output asyncapi/generator:1.17.25 /app/network_survey_messaging.yaml @asyncapi/html-template@2.3.9 -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 7587baa

Please sign in to comment.