From 7587baa1ba4ccc8dd5b0e434726ecee4b33eb89b Mon Sep 17 00:00:00 2001 From: christianrowlands Date: Mon, 5 Aug 2024 12:29:00 -0400 Subject: [PATCH] Update the version numbers for building the AsyncAPI docs --- .github/workflows/ci.yaml | 6 +++--- .github/workflows/doc_and_library_release.yaml | 6 +++--- README.md | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index ca68cee..91c6e01 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -15,14 +15,14 @@ jobs: uses: actions/checkout@v4 - name: Validating AsyncAPI document - uses: asyncapi/github-action-for-cli@v3.1.1 + uses: asyncapi/github-action-for-cli@v3.1.2 with: command: validate filepath: src/main/asyncapi/network_survey_messaging.yaml - name: Generating HTML from my AsyncAPI document - uses: asyncapi/github-action-for-cli@v3.1.1 + uses: asyncapi/github-action-for-cli@v3.1.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 diff --git a/.github/workflows/doc_and_library_release.yaml b/.github/workflows/doc_and_library_release.yaml index 1859c1b..926d78c 100644 --- a/.github/workflows/doc_and_library_release.yaml +++ b/.github/workflows/doc_and_library_release.yaml @@ -78,15 +78,15 @@ jobs: ref: develop - name: Validating AsyncAPI document - uses: asyncapi/github-action-for-cli@v3.1.1 + uses: asyncapi/github-action-for-cli@v3.1.2 with: command: validate filepath: src/main/asyncapi/network_survey_messaging.yaml - name: Generating HTML from my AsyncAPI document - uses: asyncapi/github-action-for-cli@v3.1.1 + uses: asyncapi/github-action-for-cli@v3.1.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 diff --git a/README.md b/README.md index 48c17b3..ac21a97 100644 --- a/README.md +++ b/README.md @@ -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`