Merge branch 'master' into Edit_tutorial_Yuan

.all-contributorsrc

@@ -8,7 +8,7 @@
   ],
   "imageSize": 100,
   "commit": false,
-  "commitConvention": "none",
+  "commitConvention": "angular",
   "contributors": [
     {
       "login": "fmvilas",
@@ -167,6 +167,15 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "GavinZhengOI",
+      "name": "GavinZhengOI",
+      "avatar_url": "https://avatars.githubusercontent.com/u/33168669?v=4",
+      "profile": "https://blog.orzzh.icu/",
+      "contributions": [
+        "doc"
+      ]
     }
   ],
   "contributorsPerLine": 3,

.github/workflows/help-command.yml

@@ -31,6 +31,7 @@ jobs:
         
                     At the moment the following comments are supported in pull requests:
 
+                    - \`/please-take-a-look` or \`/ptal\` - This comment will add a comment to the PR asking for attention from the reviewrs who have not reviewed the PR yet.
                     - \`/ready-to-merge\` or \`/rtm\` - This comment will trigger automerge of PR in case all required checks are green, approvals in place and do-not-merge label is not added
                     - \`/do-not-merge\` or \`/dnm\` - This comment will block automerging even if all conditions are met and ready-to-merge label is added
                     - \`/autoupdate\` or \`/au\` - This comment will add \`autoupdate\` label to the PR and keeps your PR up-to-date to the target branch's future changes. Unless there is a merge conflict or it is a draft PR.`

.github/workflows/if-nodejs-pr-testing.yml

@@ -33,6 +33,7 @@ jobs:
         id: should_run
         name: Should Run
         run: echo "shouldrun=true" >> $GITHUB_OUTPUT
+        shell: bash
       - if: steps.should_run.outputs.shouldrun == 'true' 
         name: Set git to use LF #to once and for all finish neverending fight between Unix and Windows
         run: |
@@ -60,13 +61,13 @@ jobs:
       - if: steps.packagejson.outputs.exists == 'true'
         name: Install dependencies
         id: first-installation
-        run: npm install --loglevel verbose
+        run: npm ci
         continue-on-error: true
       - if: steps.first-installation.outputs.status == 'failure' && steps.packagejson.outputs.exists == 'true'
         name: Clear NPM cache and install deps again
         run: | 
           npm cache clean --force
-          npm install --loglevel verbose
+          npm ci
       - if: steps.packagejson.outputs.exists == 'true'
         name: Test
         run: npm test --if-present

.github/workflows/if-nodejs-release.yml

@@ -85,6 +85,7 @@ jobs:
       - name: Check if Node.js project and has package.json
         id: packagejson
         run: test -e ./package.json && echo "exists=true" >> $GITHUB_OUTPUT || echo "exists=false" >> $GITHUB_OUTPUT
+        shell: bash
       - if: steps.packagejson.outputs.exists == 'true'
         name: Check package-lock version
         uses: asyncapi/.github/.github/actions/get-node-version-from-package-lock@master
@@ -98,7 +99,14 @@ jobs:
           cache-dependency-path: '**/package-lock.json'
       - if: steps.packagejson.outputs.exists == 'true'
         name: Install dependencies
-        run: npm install
+        id: first-installation
+        run: npm ci
+        continue-on-error: true
+      - if: steps.first-installation.outputs.status == 'failure' && steps.packagejson.outputs.exists == 'true'
+        name: Clear NPM cache and install deps again
+        run: | 
+          npm cache clean --force
+          npm ci
       - if: steps.packagejson.outputs.exists == 'true'
         name: Add plugin for conventional commits for semantic-release
         run: npm install --save-dev [email protected]

.github/workflows/if-nodejs-version-bump.yml

@@ -37,7 +37,7 @@ jobs:
           cache-dependency-path: '**/package-lock.json'
       - if: steps.packagejson.outputs.exists == 'true'
         name: Install dependencies
-        run: npm install
+        run: npm ci
       - if: steps.packagejson.outputs.exists == 'true'
         name: Assets generation
         run: npm run generate:assets --if-present

.github/workflows/please-take-a-look-command.yml

@@ -0,0 +1,54 @@
+# This action is centrally managed in https://github.com/asyncapi/.github/
+# Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in above mentioned repo
+
+# It uses Github actions to listen for comments on issues and pull requests and 
+# if the comment contains /ping-for-attention or /pfa it will add a comment pinging 
+# the code-owners who have not yet reviewed the pull request
+
+name: Please take a Look
+
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  ping-for-attention:
+    if: >
+      github.event.issue.pull_request &&
+      github.event.issue.state != 'closed' &&
+      github.actor != 'asyncapi-bot' &&
+      (
+        contains(github.event.comment.body, '/please-take-a-look') ||
+        contains(github.event.comment.body, '/ptal') ||
+        contains(github.event.comment.body, '/PTAL') 
+      )
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check for Please Take a Look Command
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{ secrets.GH_TOKEN }}
+          script: |
+            const prDetailsUrl = context.payload.issue.pull_request.url;
+            const { data: pull } = await github.request(prDetailsUrl);
+            const reviewers = pull.requested_reviewers.map(reviewer => reviewer.login);
+
+            const { data: reviews } = await github.rest.pulls.listReviews({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              pull_number: context.issue.number
+            });
+
+            const reviewersWhoHaveReviewed = reviews.map(review => review.user.login);
+
+            const reviewersWhoHaveNotReviewed = reviewers.filter(reviewer => !reviewersWhoHaveReviewed.includes(reviewer));
+
+            if (reviewersWhoHaveNotReviewed.length > 0) {
+              const comment = reviewersWhoHaveNotReviewed.map(reviewer => `@${reviewer}`).join(' ');
+              await github.rest.issues.createComment({
+                issue_number: context.issue.number,
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                body: `${comment} Please take a look at this PR. Thanks! :wave:`
+              });
+            }

.github/workflows/pr-testing-with-test-project.yml

@@ -17,5 +17,5 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v3
       - name: Run test
-        run: NODE_IMAGE_TAG=${{ matrix.node }} docker-compose up --abort-on-container-exit --remove-orphans --force-recreate
+        run: NODE_IMAGE_TAG=${{ matrix.node }} docker compose up --abort-on-container-exit --remove-orphans --force-recreate
         working-directory: ./test/test-project

README.md

@@ -81,6 +81,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     </tr>
     <tr>
       <td align="center" valign="top" width="33.33%"><a href="https://github.com/swastiksuvam55"><img src="https://avatars.githubusercontent.com/u/90003260?v=4?s=100" width="100px;" alt="swastik suvam singh"/><br /><sub><b>swastik suvam singh</b></sub></a><br /><a href="https://github.com/asyncapi/generator/commits?author=swastiksuvam55" title="Code">💻</a></td>
+      <td align="center" valign="top" width="33.33%"><a href="https://blog.orzzh.icu/"><img src="https://avatars.githubusercontent.com/u/33168669?v=4?s=100" width="100px;" alt="GavinZhengOI"/><br /><sub><b>GavinZhengOI</b></sub></a><br /><a href="https://github.com/asyncapi/generator/commits?author=GavinZhengOI" title="Documentation">📖</a></td>
     </tr>
   </tbody>
 </table>

docs/generator-template.md

@@ -208,7 +208,8 @@ class TemperatureServiceClient:
         self.client.publish(topic, id)
 ```
 
-Make sure you have the Paho-MQTT library installed. You can install it using pip with the `pip install paho-mqtt` command.
+Make sure you have the Paho-MQTT library installed. You can install it using pip with the `pip install paho-mqtt==1.6.1` command. Please note that this tutorial is based on Paho-MQTT version 1.6.1. The Paho-MQTT library has since been updated to version 2.0.0, which includes changes that are not covered in this tutorial. To ensure compatibility and to follow along without any issues, please install version 1.6.1 of the Paho-MQTT library.
+
 Let's break down the previous code snippet:
 
 1. Imports the MQTT module from the Paho package, which provides the MQTT client functionality.
@@ -357,7 +358,7 @@ Generator Error: This template requires the following missing params: server.
 Update your `test:generate` script in **package.json** to include the server param
 
 ```json
-test:generate": "asyncapi generate fromTemplate test/fixtures/asyncapi.yml ./ --output test/project --force-write --param server=dev"
+"test:generate": "asyncapi generate fromTemplate test/fixtures/asyncapi.yml ./ --output test/project --force-write --param server=dev"
 ```
 
 You can now replace the static broker from `mqttBroker = 'test.mosquitto.org'` to `mqttBroker = "${asyncapi.servers().get(params.server).url()}"` in **index.js**.

docs/usage.md

@@ -8,24 +8,29 @@ There are two ways to use the generator:
 - [Generator library](#using-as-a-modulepackage)
 
 ## AsyncAPI CLI
+Generates whatever you want using templates compatible with AsyncAPI Generator.
 ```bash
-Usage: asyncapi generate fromTemplate <asyncapi> <template> [<options>]
+USAGE
+  $ asyncapi generate fromTemplate [ASYNCAPI] [TEMPLATE] [-h] [-d <value>] [-i] [--debug] [-n <value>] [-o <value>] [--force-write] [-w] [-p <value>] [--map-base-url <value>]
 
-- <asyncapi>: Local path or URL pointing to AsyncAPI document for example https://bit.ly/asyncapi
-- <template>: Name of the generator template like for example @asyncapi/html-template or https://github.com/asyncapi/html-template
+ARGUMENTS
+  ASYNCAPI  - Local path, url or context-name pointing to AsyncAPI file
+  TEMPLATE  - Name of the generator template like for example @asyncapi/html-template or https://github.com/asyncapi/html-template
 
-- <options>:
-  -V, --version                  output the generator version
-  -d, --disable-hook [hooks...]  disable a specific hook type or hooks from a given hook type
-  --debug                        enable more specific errors in the console
-  -i, --install                  install the template and its dependencies (defaults to false)
-  -n, --no-overwrite <glob>      glob or path of the file(s) to skip when regenerating
-  -o, --output <outputDir>       directory to put the generated files (defaults to current directory)
-  -p, --param <name=value>       additional parameters to pass to templates
-  --force-write                  force writing of the generated files to a given directory even if it is a Git repository with unstaged files or not empty dir (defaults to false)
-  --watch-template               watches the template directory and the AsyncAPI document, and re-generates the files when changes occur. Ignores the output directory. This flag should be used only for template development.
-  --map-base-url <url:folder>    maps all schema references from base URL to local folder
-  -h, --help                     display help for command
+FLAGS
+  -d, --disable-hook=<value>...  Disable a specific hook type or hooks from a given hook type
+  -h, --help                     Show CLI help.
+  -i, --install                  Installs the template and its dependencies (defaults to false)
+  -n, --no-overwrite=<value>...  Glob or path of the file(s) to skip when regenerating
+  -o, --output=<value>           Directory where to put the generated files (defaults to current directory)
+  -p, --param=<value>...         Additional param to pass to templates
+  -w, --watch                    Watches the template directory and the AsyncAPI document, and re-generate the files when changes occur. Ignores the output directory.
+  --debug                        Enable more specific errors in the console
+  --force-write                  Force writing of the generated files to given directory even if it is a git repo with unstaged files or not empty dir (defaults to false)
+  --map-base-url=<value>         Maps all schema references from base url to local folder
+
+EXAMPLES
+  $ asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --param version=1.0.0 singleFile=true --output ./docs --force-write
 ```
 
 All templates are installable npm packages. Therefore, the value of `template` can be anything supported by `npm install`. Here's a summary of the possibilities:
@@ -149,4 +154,4 @@ try {
 }
 ```
 
-See the [API documentation](api.md) for more examples and full API reference information.
+See the [API documentation](api) for more examples and full API reference information.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asyncapi/generator",
-  "version": "1.17.12",
+  "version": "1.17.17",
   "description": "The AsyncAPI generator. It can generate documentation, code, anything!",
   "main": "./lib/generator.js",
   "bin": {
@@ -48,8 +48,8 @@
   "license": "Apache-2.0",
   "homepage": "https://github.com/asyncapi/generator",
   "dependencies": {
-    "@asyncapi/generator-react-sdk": "^1.0.13",
-    "@asyncapi/parser": "^3.0.10",
+    "@asyncapi/generator-react-sdk": "^1.0.15",
+    "@asyncapi/parser": "^3.0.11",
     "@npmcli/arborist": "5.6.3",
     "@smoya/multi-parser": "^5.0.0",
     "ajv": "^8.12.0",

test/test-project/package.json

@@ -11,7 +11,7 @@
     },
     "dependencies": {
         "@asyncapi/generator": "file:../..",
-        "@asyncapi/html-template": "0.16.0"
+        "@asyncapi/html-template": "^2.3.0"
     },
     "devDependencies": {
         "fs-extra": "9.1.0",
@@ -24,4 +24,4 @@
             "^nimma/(.*)": "<rootDir>/../../node_modules/nimma/dist/cjs/$1"
         }
     }
-}
+}