[ { "path": ".all-contributorsrc", "content": "{\n \"files\": [\n \"README.md\"\n ],\n \"imageSize\": 100,\n \"commit\": false,\n \"contributors\": [\n {\n \"login\": \"jotamusik\",\n \"name\": \"Jorge Aguiar Martín\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/14940638?v=4\",\n \"profile\": \"https://github.com/jotamusik\",\n \"contributions\": [\n \"code\",\n \"ideas\",\n \"test\",\n \"doc\"\n ]\n },\n {\n \"login\": \"derberg\",\n \"name\": \"Lukasz Gornicki\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/6995927?v=4\",\n \"profile\": \"https://www.brainfart.dev/\",\n \"contributions\": [\n \"ideas\",\n \"code\",\n \"review\",\n \"maintenance\"\n ]\n },\n {\n \"login\": \"Souvikns\",\n \"name\": \"souvik\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/41781438?v=4\",\n \"profile\": \"https://souvik.vercel.app/\",\n \"contributions\": [\n \"code\",\n \"ideas\",\n \"test\",\n \"review\",\n \"maintenance\",\n \"doc\"\n ]\n },\n {\n \"login\": \"boyney123\",\n \"name\": \"David Boyne\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/3268013?v=4\",\n \"profile\": \"https://boyney.io/\",\n \"contributions\": [\n \"code\",\n \"ideas\",\n \"maintenance\"\n ]\n },\n {\n \"login\": \"fmvilas\",\n \"name\": \"Fran Méndez\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/242119?v=4\",\n \"profile\": \"http://www.fmvilas.com/\",\n \"contributions\": [\n \"code\",\n \"ideas\",\n \"review\"\n ]\n },\n {\n \"login\": \"magicmatatjahu\",\n \"name\": \"Maciej Urbańczyk\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/20404945?v=4\",\n \"profile\": \"https://github.com/magicmatatjahu\",\n \"contributions\": [\n \"review\",\n \"maintenance\",\n \"ideas\"\n ]\n },\n {\n \"login\": \"aayushmau5\",\n \"name\": \"Aayush Kumar Sahu\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/54525741?v=4\",\n \"profile\": \"https://aayushsahu.com/\",\n \"contributions\": [\n \"code\",\n \"test\"\n ]\n },\n {\n \"login\": \"mihirterna\",\n \"name\": \"Mihir Kulkarni\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/31316452?v=4\",\n \"profile\": \"https://github.com/mihirterna\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"imabp\",\n \"name\": \"Abir\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/53480076?v=4\",\n \"profile\": \"https://imabp.github.io/resume/\",\n \"contributions\": [\n \"test\",\n \"code\"\n ]\n },\n {\n \"login\": \"peter-rr\",\n \"name\": \"Peter Ramos\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/81691177?v=4\",\n \"profile\": \"https://github.com/peter-rr\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"Samridhi-98\",\n \"name\": \"Samriddhi\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/54466041?v=4\",\n \"profile\": \"https://samridhi-98.github.io/Portfolio\",\n \"contributions\": [\n \"test\"\n ]\n },\n {\n \"login\": \"pranay202\",\n \"name\": \"Pranay Kharabe\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/68046838?v=4\",\n \"profile\": \"https://linktr.ee/KharabePranay\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"activus-d\",\n \"name\": \"Damilola Oladele\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/98895460?v=4\",\n \"profile\": \"https://d-m-oladele.netlify.app/\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"prayutsu\",\n \"name\": \"Abhay Garg\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/54636525?v=4\",\n \"profile\": \"https://github.com/prayutsu\",\n \"contributions\": [\n \"code\",\n \"test\"\n ]\n },\n {\n \"login\": \"sambhavgupta0705\",\n \"name\": \"Sambhav Gupta\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/81870866?v=4\",\n \"profile\": \"https://github.com/sambhavgupta0705\",\n \"contributions\": [\n \"code\",\n \"test\"\n ]\n },\n {\n \"login\": \"CyberHippo\",\n \"name\": \"Hippolyte Vergnol\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/18269437?v=4\",\n \"profile\": \"https://github.com/CyberHippo\",\n \"contributions\": [\n \"code\",\n \"infra\"\n ]\n },\n {\n \"login\": \"Vetsoo\",\n \"name\": \"Jente Vets\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/22449126?v=4\",\n \"profile\": \"https://www.jentevets.com\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"kaushik-rishi\",\n \"name\": \"Rishi\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/52498617?v=4\",\n \"profile\": \"https://github.com/kaushik-rishi\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"Shurtu-gal\",\n \"name\": \"Ashish Padhy\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/100484401?v=4\",\n \"profile\": \"http://ashishpadhy.live\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"meetagrawal09\",\n \"name\": \"Meet Agrawal\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/73902874?v=4\",\n \"profile\": \"https://github.com/meetagrawal09\",\n \"contributions\": [\n \"infra\"\n ]\n },\n {\n \"login\": \"chinma-yyy\",\n \"name\": \"Chinmay Shewale\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/112387862?v=4\",\n \"profile\": \"https://www.chinmayyy.tech\",\n \"contributions\": [\n \"code\",\n \"test\"\n ]\n },\n {\n \"login\": \"mhmohona\",\n \"name\": \"Mahfuza Humayra Mohona\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/14244685?v=4\",\n \"profile\": \"https://github.com/mhmohona\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"GreenRover\",\n \"name\": \"Heiko Henning\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/512850?v=4\",\n \"profile\": \"https://github.com/GreenRover\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"AayushSaini101\",\n \"name\": \"Zack_Aayush\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/60972989?v=4\",\n \"profile\": \"https://www.linkedin.com/in/aayush-saini-0a25931b1/\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"ayushnau\",\n \"name\": \"Ayush Nautiyal\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/78146753?v=4\",\n \"profile\": \"https://github.com/ayushnau\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"Anish Kacham\",\n \"name\": \"AnishKacham\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/79566582?v=4\",\n \"profile\": \"https://github.com/AnishKacham\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"aeworxet\",\n \"name\": \"Viacheslav Turovskyi\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/16149591?v=4\",\n \"profile\": \"https://github.com/aeworxet\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"amanbedi1\",\n \"name\": \"Amanpreet Singh Bedi \",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/82234871?v=4\",\n \"profile\": \"https://github.com/amanbedi1\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"ron-debajyoti\",\n \"name\": \"Debajyoti Halder\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/22571664?v=4\",\n \"profile\": \"https://github.com/ron-debajyoti\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"Savio629\",\n \"name\": \"Savio Dias\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/91362589?v=4\",\n \"profile\": \"https://github.com/Savio629\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"jonaslagoni\",\n \"name\": \"Jonas Lagoni\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/13396189?v=4\",\n \"profile\": \"https://github.com/jonaslagoni\",\n \"contributions\": [\n \"code\",\n \"ideas\",\n \"review\",\n \"test\"\n ]\n },\n {\n \"login\": \"KhudaDad414\",\n \"name\": \"Khuda Dad Nomani\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/32505158?v=4\",\n \"profile\": \"https://github.com/KhudaDad414\",\n \"contributions\": [\n \"code\",\n \"doc\"\n ]\n },\n {\n \"login\": \"smoya\",\n \"name\": \"Sergio Moya \",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/1083296?v=4\",\n \"profile\": \"https://github.com/smoya\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"Vishal2002\",\n \"name\": \"Vishal Sharma\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/35897449?v=4\",\n \"profile\": \"https://github.com/Vishal2002\",\n \"contributions\": [\n \"code\"\n ]\n }\n ],\n \"contributorsPerLine\": 7,\n \"projectName\": \"cli\",\n \"projectOwner\": \"asyncapi\",\n \"repoType\": \"github\",\n \"repoHost\": \"https://github.com\",\n \"skipCi\": false,\n \"commitConvention\": \"angular\",\n \"commitType\": \"docs\"\n}\n" }, { "path": ".asyncapi-tool", "content": "title: AsyncAPI CLI\ndescription: |\n One CLI to rule them all. \n This is a CLI that aims to integrate all AsyncAPI tools that you need while AsyncAPI document development and maintainance. \n You can use it to generate docs or code, validate AsyncAPI document and event create new documents.\nlinks:\n websiteUrl: https://www.asyncapi.com/tools/cli\nfilters:\n technology:\n - TypeScript\n categories:\n - others\n - cli\n hasCommercial: false" }, { "path": ".changeset/config.json", "content": "{\n \"$schema\": \"https://unpkg.com/@changesets/config@2.3.0/schema.json\",\n \"changelog\": [\"@changesets/changelog-git\", { \"repo\": \"asyncapi/cli\" }],\n \"commit\": false,\n \"fixed\": [],\n \"linked\": [],\n \"access\": \"public\",\n \"baseBranch\": \"master\",\n \"updateInternalDependencies\": \"patch\",\n \"privatePackages\": {\n \"version\": true,\n \"tag\": true\n }\n}\n" }, { "path": ".dockerignore", "content": "node_modules\nnpm-debug.log\nDockerfile\n.dockerignore\n.git\n" }, { "path": ".editorconfig", "content": "root = true\n\n[*]\nindent_style = space\nindent_size = 2\ncharset = utf-8\ntrim_trailing_whitespace = true\ninsert_final_newline = true\n\n[*.md]\ntrim_trailing_whitespace = false\n" }, { "path": ".gitattributes", "content": "* text=auto eol=lf\n" }, { "path": ".github/workflows/add-good-first-issue-labels.yml", "content": "# This workflow is centrally managed in https://github.com/asyncapi/.github/\n# 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\n\n# Purpose of this workflow is to enable anyone to label issue with 'Good First Issue' and 'area/*' with a single command.\nname: Add 'Good First Issue' and 'area/*' labels # if proper comment added\n\non:\n issue_comment:\n types:\n - created\n\npermissions: {}\n\njobs:\n add-labels:\n name: Add 'Good First Issue' and 'area/*' labels\n if: ${{(!github.event.issue.pull_request && github.event.issue.state != 'closed' && github.actor != 'asyncapi-bot') && (contains(github.event.comment.body, '/good-first-issue') || contains(github.event.comment.body, '/gfi' ))}}\n runs-on: ubuntu-latest\n permissions:\n issues: write # This is needed to add labels to issues.\n steps:\n - name: Add label\n uses: actions/github-script@v7\n with:\n github-token: ${{ github.token }}\n script: |\n const areas = ['javascript', 'typescript', 'java' , 'go', 'docs', 'ci-cd', 'design'];\n const words = context.payload.comment.body.trim().split(\" \");\n const areaIndex = words.findIndex((word)=> word === '/gfi' || word === '/good-first-issue') + 1\n let area = words[areaIndex];\n switch(area){\n case 'ts':\n area = 'typescript';\n break;\n case 'js':\n area = 'javascript';\n break;\n case 'markdown':\n area = 'docs';\n break;\n }\n if(!areas.includes(area)){\n const message = `Hey @${context.payload.sender.login}, your message doesn't follow the requirements, you can try \\`/help\\`.`\n\n await github.rest.issues.createComment({\n issue_number: context.issue.number,\n owner: context.repo.owner,\n repo: context.repo.repo,\n body: message\n })\n } else {\n\n // remove area if there is any before adding new labels.\n const currentLabels = (await github.rest.issues.listLabelsOnIssue({\n issue_number: context.issue.number,\n owner: context.repo.owner,\n repo: context.repo.repo,\n })).data.map(label => label.name);\n\n const shouldBeRemoved = currentLabels.filter(label => (label.startsWith('area/') && !label.endsWith(area)));\n shouldBeRemoved.forEach(label => {\n github.rest.issues.deleteLabel({\n owner: context.repo.owner,\n repo: context.repo.repo,\n name: label,\n });\n });\n\n // Add new labels.\n github.rest.issues.addLabels({\n issue_number: context.issue.number,\n owner: context.repo.owner,\n repo: context.repo.repo,\n labels: ['good first issue', `area/${area}`]\n });\n }\n" }, { "path": ".github/workflows/automerge-for-humans-add-ready-to-merge-or-do-not-merge-label.yml", "content": "# This workflow is centrally managed in https://github.com/asyncapi/.github/\n# 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\n\n# Purpose of this workflow is to enable anyone to label PR with the following labels:\n# `ready-to-merge` and `do-not-merge` labels to get stuff merged or blocked from merging\n# `autoupdate` to keep a branch up-to-date with the target branch\n\nname: Label PRs # if proper comment added\n\non:\n issue_comment:\n types:\n - created\n\npermissions: {}\n\njobs:\n add-ready-to-merge-label:\n name: Add ready-to-merge label\n permissions:\n issues: write # required to add labels and post comments on PR issues\n pull-requests: write # required to read PR metadata from the issue pull_request URL\n contents: read # required to compare PR branch commits against base\n if: >\n github.event.issue.pull_request && \n github.event.issue.state != 'closed' && \n github.actor != 'asyncapi-bot' && \n (\n contains(github.event.comment.body, '/ready-to-merge') || \n contains(github.event.comment.body, '/rtm' )\n )\n\n runs-on: ubuntu-latest\n steps:\n - name: Add ready-to-merge label\n uses: actions/github-script@v7\n env:\n GITHUB_ACTOR: ${{ github.actor }}\n with:\n github-token: ${{ github.token }}\n script: |\n const prDetailsUrl = context.payload.issue.pull_request.url;\n const { data: pull } = await github.request(prDetailsUrl);\n const { draft: isDraft} = pull;\n if(!isDraft) {\n console.log('adding ready-to-merge label...');\n github.rest.issues.addLabels({\n issue_number: context.issue.number,\n owner: context.repo.owner,\n repo: context.repo.repo,\n labels: ['ready-to-merge']\n }) \n }\n\n const { data: comparison } =\n await github.rest.repos.compareCommitsWithBasehead({\n owner: pull.head.repo.owner.login,\n repo: pull.head.repo.name,\n basehead: `${pull.base.label}...${pull.head.label}`,\n });\n if (comparison.behind_by !== 0 && pull.mergeable_state === 'behind') {\n console.log(`This branch is behind the target by ${comparison.behind_by} commits`)\n console.log('adding out-of-date comment...');\n github.rest.issues.createComment({\n issue_number: context.issue.number,\n owner: context.repo.owner,\n repo: context.repo.repo,\n body: `Hello, @${process.env.GITHUB_ACTOR}! 👋🏼\n This PR is not up to date with the base branch and can't be merged.\n Please update your branch manually with the latest version of the base branch.\n PRO-TIP: To request an update from the upstream branch, simply comment \\`/u\\` or \\`/update\\` and our bot will handle the update operation promptly.\n \n The only requirement for this to work is to enable [Allow edits from maintainers](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork) option in your PR. Also the update will not work if your fork is located in an organization, not under your personal profile.\n Thanks 😄`\n })\n }\n\n add-do-not-merge-label:\n name: Add do-not-merge label\n permissions:\n issues: write # required to add labels on PR issues\n pull-requests: write # required to read PR metadata from the issue pull_request URL\n if: >\n github.event.issue.pull_request &&\n github.event.issue.state != 'closed' &&\n github.actor != 'asyncapi-bot' &&\n (\n contains(github.event.comment.body, '/do-not-merge') ||\n contains(github.event.comment.body, '/dnm' )\n )\n runs-on: ubuntu-latest\n steps:\n - name: Add do-not-merge label\n uses: actions/github-script@v7\n with:\n github-token: ${{ github.token }}\n script: |\n github.rest.issues.addLabels({\n issue_number: context.issue.number,\n owner: context.repo.owner,\n repo: context.repo.repo,\n labels: ['do-not-merge']\n })\n add-autoupdate-label:\n name: Add autoupdate label\n permissions:\n issues: write # required to add labels on PR issues\n pull-requests: write # required to read PR metadata from the issue pull_request URL\n if: >\n github.event.issue.pull_request && \n github.event.issue.state != 'closed' && \n github.actor != 'asyncapi-bot' &&\n (\n contains(github.event.comment.body, '/autoupdate') ||\n contains(github.event.comment.body, '/au' )\n )\n runs-on: ubuntu-latest\n steps:\n - name: Add autoupdate label\n uses: actions/github-script@v7\n with:\n github-token: ${{ github.token }}\n script: |\n github.rest.issues.addLabels({\n issue_number: context.issue.number,\n owner: context.repo.owner,\n repo: context.repo.repo,\n labels: ['autoupdate']\n })\n" }, { "path": ".github/workflows/automerge-for-humans-merging.yml", "content": "# This workflow is centrally managed in https://github.com/asyncapi/.github/\n# 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\n\n# Purpose of this workflow is to allow people to merge PR without a need of maintainer doing it. If all checks are in place (including maintainers approval) - JUST MERGE IT!\nname: Automerge For Humans\n\non:\n pull_request_target:\n types:\n - labeled\n - unlabeled\n - synchronize\n - opened\n - edited\n - ready_for_review\n - reopened\n - unlocked # zizmor: ignore[dangerous-triggers] needed if we want author to be our bot\n\npermissions: {}\n\njobs:\n automerge-for-humans:\n name: Automerge PRs labeled with ready-to-merge\n permissions:\n contents: read # required for PR commit metadata reads\n pull-requests: read # required to read pull request details in github-script steps\n # it runs only if PR actor is not a bot, at least not a bot that we know\n if: |\n github.event.pull_request.draft == false && \n !contains(fromJSON('[\"asyncapi-bot\",\"dependabot[bot]\",\"dependabot-preview[bot]\"]'), github.event.pull_request.user.login)\n runs-on: ubuntu-latest\n steps:\n - name: Get PR authors\n id: authors\n uses: actions/github-script@v7\n with:\n script: |\n // Get paginated list of all commits in the PR\n try {\n const commitOpts = github.rest.pulls.listCommits.endpoint.merge({\n owner: context.repo.owner,\n repo: context.repo.repo,\n pull_number: context.issue.number\n });\n\n const commits = await github.paginate(commitOpts);\n\n if (commits.length === 0) {\n core.setFailed('No commits found in the PR');\n return '';\n }\n\n // Get unique authors from the commits list\n const authors = commits.reduce((acc, commit) => {\n const username = commit.author?.login || commit.commit.author?.name;\n if (username && !acc[username]) {\n acc[username] = {\n name: commit.commit.author?.name,\n email: commit.commit.author?.email,\n }\n }\n\n return acc;\n }, {});\n\n return authors;\n } catch (error) {\n core.setFailed(error.message);\n return [];\n }\n\n - name: Create commit message\n id: create-commit-message\n uses: actions/github-script@v7\n env:\n AUTHORS_JSON: ${{ steps.authors.outputs.result }}\n with:\n script: |\n const authors = JSON.parse(process.env.AUTHORS_JSON);\n\n if (Object.keys(authors).length === 0) {\n core.setFailed('No authors found in the PR');\n return '';\n }\n\n // Create a string of the form \"Co-authored-by: Name \"\n // ref: https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors\n const coAuthors = Object.values(authors).map(author => {\n return `Co-authored-by: ${author.name} <${author.email}>`;\n }).join('\\n');\n\n core.debug(coAuthors);;\n\n return coAuthors;\n\n - name: Automerge PR\n uses: pascalgn/automerge-action@22948e0bc22f0aa673800da838595a3e7347e584 #v0.15.6 https://github.com/pascalgn/automerge-action/releases/tag/v0.15.6\n env:\n GITHUB_TOKEN: \"${{ secrets.GH_TOKEN }}\"\n MERGE_LABELS: \"!do-not-merge,ready-to-merge\"\n MERGE_METHOD: \"squash\"\n # Using the output of the previous step (`Co-authored-by: ...` lines) as commit description.\n # Important to keep 2 empty lines as https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors#creating-co-authored-commits-on-the-command-line mentions\n MERGE_COMMIT_MESSAGE: \"{pullRequest.title} (#{pullRequest.number})\\n\\n\\n${{ fromJSON(steps.create-commit-message.outputs.result) }}\"\n MERGE_RETRIES: \"20\"\n MERGE_RETRY_SLEEP: \"30000\"\n" }, { "path": ".github/workflows/automerge-for-humans-remove-ready-to-merge-label-on-edit.yml", "content": "# This workflow is centrally managed in https://github.com/asyncapi/.github/\n# 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\n\n# Defence from evil contributor that after adding `ready-to-merge` all suddenly makes evil commit or evil change in PR title\n# Label is removed once above action is detected\nname: Remove ready-to-merge label\n\non:\n pull_request:\n types:\n - synchronize\n - edited\n\npermissions: {}\n\njobs:\n remove-ready-label:\n name: Remove ready-to-merge label\n runs-on: ubuntu-latest\n permissions:\n pull-requests: write # required to remove labels and post comments on PR issues \n steps:\n - name: Remove label\n uses: actions/github-script@v7\n with:\n github-token: ${{ github.token }}\n script: |\n const labelToRemove = 'ready-to-merge';\n const labels = context.payload.pull_request.labels;\n const isLabelPresent = labels.some(label => label.name === labelToRemove)\n if(!isLabelPresent) return;\n github.rest.issues.removeLabel({\n issue_number: context.issue.number,\n owner: context.repo.owner,\n repo: context.repo.repo,\n name: labelToRemove\n })\n" }, { "path": ".github/workflows/automerge-orphans.yml", "content": "# This action is centrally managed in https://github.com/asyncapi/.github/\n# 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\n\nname: 'Notify on failing automerge'\n\non:\n schedule:\n - cron: \"0 0 * * *\"\n\npermissions: {}\n\njobs:\n identify-orphans:\n if: startsWith(github.repository, 'asyncapi/')\n name: Find orphans and notify\n permissions:\n contents: read # required by checkout and repository metadata reads\n pull-requests: read # required to list open pull requests\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n with:\n persist-credentials: false\n - name: Get list of orphans\n uses: actions/github-script@v7\n id: orphans\n with:\n github-token: ${{ github.token }}\n script: |\n const query = `query($owner:String!, $name:String!) {\n repository(owner:$owner, name:$name){\n pullRequests(first: 100, states: OPEN){\n nodes{\n title\n url\n author {\n resourcePath\n }\n }\n }\n }\n }`;\n const variables = {\n owner: context.repo.owner,\n name: context.repo.repo\n };\n const { repository: { pullRequests: { nodes } } } = await github.graphql(query, variables);\n\n let orphans = nodes.filter( (pr) => pr.author.resourcePath === '/asyncapi-bot' || pr.author.resourcePath === '/apps/dependabot')\n\n if (orphans.length) {\n core.setOutput('found', 'true');\n //Yes, this is very naive approach to assume there is just one PR causing issues, there can be a case that more PRs are affected the same day\n //The thing is that handling multiple PRs will increase a complexity in this PR that in my opinion we should avoid\n //The other PRs will be reported the next day the action runs, or person that checks first url will notice the other ones\n core.setOutput('url', orphans[0].url);\n core.setOutput('title', orphans[0].title);\n }\n - if: steps.orphans.outputs.found == 'true'\n name: Convert markdown to slack markdown\n # This workflow is from our own org repo and safe to reference by 'master'.\n uses: asyncapi/.github/.github/actions/slackify-markdown@master # //NOSONAR\n id: issuemarkdown\n with:\n markdown: \"-> [${{steps.orphans.outputs.title}}](${{steps.orphans.outputs.url}})\"\n - if: steps.orphans.outputs.found == 'true'\n name: Send info about orphan to slack\n uses: rtCamp/action-slack-notify@c33737706dea87cd7784c687dadc9adf1be59990 # Using v2.3.2\n env:\n SLACK_WEBHOOK: ${{secrets.SLACK_CI_FAIL_NOTIFY}}\n SLACK_TITLE: 🚨 Not merged PR that should be automerged 🚨\n SLACK_MESSAGE: ${{steps.issuemarkdown.outputs.text}}\n MSG_MINIMAL: true" }, { "path": ".github/workflows/automerge.yml", "content": "# This action is centrally managed in https://github.com/asyncapi/.github/\n# 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.\n\nname: Automerge PRs from bots\n\non:\n pull_request_target: # Needed as GH_TOKEN_BOT_EVE needed for approval.\n types:\n - opened\n - synchronize # zizmor: ignore[dangerous-triggers]\n\npermissions: {}\n\njobs:\n autoapprove-for-bot:\n name: Autoapprove PR comming from a bot\n if: >\n contains(fromJson('[\"asyncapi-bot\", \"dependabot[bot]\", \"dependabot-preview[bot]\"]'), github.event.pull_request.user.login) &&\n contains(fromJson('[\"asyncapi-bot\", \"dependabot[bot]\", \"dependabot-preview[bot]\"]'), github.actor) &&\n !contains(github.event.pull_request.labels.*.name, 'released')\n runs-on: ubuntu-latest\n steps:\n - name: Autoapproving\n uses: hmarr/auto-approve-action@44888193675f29a83e04faf4002fa8c0b537b1e4 # v3.2.1 is used https://github.com/hmarr/auto-approve-action/releases/tag/v3.2.1\n with:\n github-token: \"${{ secrets.GH_TOKEN_BOT_EVE }}\"\n\n - name: Label autoapproved\n uses: actions/github-script@v7\n with:\n github-token: ${{ secrets.GH_TOKEN }}\n script: |\n github.rest.issues.addLabels({\n issue_number: context.issue.number,\n owner: context.repo.owner,\n repo: context.repo.repo,\n labels: ['autoapproved', 'autoupdate']\n })\n\n automerge-for-bot:\n name: Automerge PR autoapproved by a bot\n needs: [autoapprove-for-bot]\n runs-on: ubuntu-latest\n steps:\n - name: Automerging\n uses: pascalgn/automerge-action@22948e0bc22f0aa673800da838595a3e7347e584 #v0.15.6 https://github.com/pascalgn/automerge-action/releases/tag/v0.15.6\n env:\n GITHUB_TOKEN: \"${{ secrets.GH_TOKEN }}\"\n GITHUB_LOGIN: asyncapi-bot\n MERGE_LABELS: \"!do-not-merge\"\n MERGE_METHOD: \"squash\"\n MERGE_COMMIT_MESSAGE: \"{pullRequest.title} (#{pullRequest.number})\"\n MERGE_RETRIES: \"20\"\n MERGE_RETRY_SLEEP: \"30000\"\n" }, { "path": ".github/workflows/autoupdate.yml", "content": "# This action is centrally managed in https://github.com/asyncapi/.github/\n# 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\n\n# This workflow is designed to work with:\n# - autoapprove and automerge workflows for dependabot and asyncapibot.\n# - special release branches that we from time to time create in upstream repos. If we open up PRs for them from the very beginning of the release, the release branch will constantly update with new things from the destination branch they are opened against\n\n# It uses GitHub Action that auto-updates pull requests branches, whenever changes are pushed to their destination branch.\n# Autoupdating to latest destination branch works only in the context of upstream repo and not forks\n\nname: autoupdate\n\non:\n push:\n branches-ignore: \n - 'version-bump/**'\n - 'dependabot/**'\n - 'bot/**'\n - 'all-contributors/**'\n\npermissions: {}\n\njobs:\n autoupdate-for-bot:\n if: startsWith(github.repository, 'asyncapi/')\n name: Autoupdate autoapproved PR created in the upstream\n runs-on: ubuntu-latest\n steps:\n - name: Autoupdating\n uses: chinthakagodawita/autoupdate@0707656cd062a3b0cf8fa9b2cda1d1404d74437e\n env:\n GITHUB_TOKEN: '${{ secrets.GH_TOKEN_BOT_EVE }}'\n PR_FILTER: \"labelled\"\n PR_LABELS: \"autoupdate\"\n PR_READY_STATE: \"ready_for_review\"\n MERGE_CONFLICT_ACTION: \"ignore\"\n" }, { "path": ".github/workflows/bounty-program-commands.yml", "content": "# This workflow is centrally managed at https://github.com/asyncapi/.github/\n# Don't make changes to this file in this repository, as they will be overwritten with\n# changes made to the same file in the abovementioned repository.\n\n# The purpose of this workflow is to allow Bounty Team members\n# (https://github.com/orgs/asyncapi/teams/bounty_team) to issue commands to the\n# organization's global AsyncAPI bot related to the Bounty Program, while at the\n# same time preventing unauthorized users from misusing them.\n\nname: Bounty Program commands\n\non:\n issue_comment:\n types:\n - created\n\nenv:\n BOUNTY_PROGRAM_LABELS_JSON: |\n [\n {\"name\": \"bounty\", \"color\": \"0e8a16\", \"description\": \"Participation in the Bounty Program\"}\n ]\n\npermissions: {}\n\njobs:\n guard-against-unauthorized-use:\n name: Guard against unauthorized use\n permissions:\n issues: write # required to post a comment on the issue/PR\n pull-requests: write # required to post a comment on the issue/PR if it's a PR\n if: >\n !contains(fromJSON('[\"aeworxet\",\"thulieblack\"]'), github.actor) &&\n (\n startsWith(github.event.comment.body, '/bounty' )\n )\n\n runs-on: ubuntu-latest\n\n steps:\n - name: ❌ @${{github.actor}} made an unauthorized attempt to use a Bounty Program's command\n uses: actions/github-script@v7\n env:\n ACTOR: ${{ github.actor }}\n with:\n github-token: ${{ github.token }}\n script: |\n const commentText = `❌ @${process.env.ACTOR} is not authorized to use the Bounty Program's commands.\n These commands can only be used by members of the [Bounty Team](https://github.com/orgs/asyncapi/teams/bounty_team).`;\n\n console.log(`❌ @${process.env.ACTOR} made an unauthorized attempt to use a Bounty Program's command.`);\n github.rest.issues.createComment({\n issue_number: context.issue.number,\n owner: context.repo.owner,\n repo: context.repo.repo,\n body: commentText\n })\n\n add-label-bounty:\n name: Add bounty label\n permissions:\n issues: write # required to read/create labels and add labels on the issue/PR\n pull-requests: write # required to read/create labels and add labels on the issue/PR\n if: >\n contains(fromJSON('[\"aeworxet\",\"thulieblack\"]'), github.actor) &&\n (\n startsWith(github.event.comment.body, '/bounty' )\n )\n\n runs-on: ubuntu-latest\n steps:\n - name: Add label `bounty`\n uses: actions/github-script@v7\n with:\n github-token: ${{ github.token }}\n script: |\n const BOUNTY_PROGRAM_LABELS = JSON.parse(process.env.BOUNTY_PROGRAM_LABELS_JSON);\n let LIST_OF_LABELS_FOR_REPO = await github.rest.issues.listLabelsForRepo({\n owner: context.repo.owner,\n repo: context.repo.repo,\n });\n \n LIST_OF_LABELS_FOR_REPO = LIST_OF_LABELS_FOR_REPO.data.map(key => key.name);\n\n if (!LIST_OF_LABELS_FOR_REPO.includes(BOUNTY_PROGRAM_LABELS[0].name)) {\n await github.rest.issues.createLabel({\n owner: context.repo.owner,\n repo: context.repo.repo,\n name: BOUNTY_PROGRAM_LABELS[0].name,\n color: BOUNTY_PROGRAM_LABELS[0].color,\n description: BOUNTY_PROGRAM_LABELS[0].description\n });\n }\n\n console.log('Adding label `bounty`...');\n github.rest.issues.addLabels({\n issue_number: context.issue.number,\n owner: context.repo.owner,\n repo: context.repo.repo,\n labels: [BOUNTY_PROGRAM_LABELS[0].name]\n })\n\n remove-label-bounty:\n name: Remove bounty label\n permissions:\n issues: write # required to read/remove labels on the issue/PR\n pull-requests: write # required to read/remove labels on the issue/PR if it's a PR\n if: >\n contains(fromJSON('[\"aeworxet\",\"thulieblack\"]'), github.actor) &&\n (\n startsWith(github.event.comment.body, '/unbounty' )\n )\n runs-on: ubuntu-latest\n steps:\n - name: Remove label `bounty`\n uses: actions/github-script@v7\n with:\n github-token: ${{ github.token }}\n script: |\n const BOUNTY_PROGRAM_LABELS = JSON.parse(process.env.BOUNTY_PROGRAM_LABELS_JSON);\n let LIST_OF_LABELS_FOR_ISSUE = await github.rest.issues.listLabelsOnIssue({\n owner: context.repo.owner,\n repo: context.repo.repo,\n issue_number: context.issue.number,\n });\n\n LIST_OF_LABELS_FOR_ISSUE = LIST_OF_LABELS_FOR_ISSUE.data.map(key => key.name);\n\n if (LIST_OF_LABELS_FOR_ISSUE.includes(BOUNTY_PROGRAM_LABELS[0].name)) {\n console.log('Removing label `bounty`...');\n github.rest.issues.removeLabel({\n issue_number: context.issue.number,\n owner: context.repo.owner,\n repo: context.repo.repo,\n name: [BOUNTY_PROGRAM_LABELS[0].name]\n })\n }\n" }, { "path": ".github/workflows/bump-homebrew-formula.yml", "content": "name: Bump Homebrew formula for CLI\n\non:\n # Since now release depends on schedule, might be that there is a situation we cannot wait for schedule and trigger release manually\n workflow_dispatch:\n # We cannot run brew release continusly every time we release something as sometimes we release a couple of times a day and overload brew pipelines\n # More details https://github.com/asyncapi/cli/issues/503\n schedule:\n - cron: \"0 23 * * *\"\n\njobs:\n bump-formula-in-homebrew:\n if: github.repository == 'asyncapi/cli'\n name: Bump the formula in homebrew-core repo\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repo\n uses: actions/checkout@v4\n - name: Get version from package.json\n id: extractver\n run: |\n VERSION=$(npm run get-version --silent)\n echo \"version=$VERSION\" >> $GITHUB_OUTPUT\n - uses: mislav/bump-homebrew-formula-action@9d4d820e1d00b99927bd36e67d41fff1cfc8bd07 # v2\n with:\n # A PR will be sent to github.com/Homebrew/homebrew-core to update AsyncAPI CLI formula:\n formula-name: asyncapi\n # https://github.com/mislav/bump-homebrew-formula-action/issues/58\n formula-path: Formula/a/asyncapi.rb\n tag-name: ${{ steps.extractver.outputs.version }}\n download-url: https://registry.npmjs.org/@asyncapi/cli/-/cli-${{ steps.extractver.outputs.version }}.tgz #we need to point to npm not github as there is a dist that is not on github\n env:\n COMMITTER_TOKEN: ${{ secrets.GH_TOKEN_BOT_EVE }}\n - if: failure() # Only, on failure, send a message on the 94_bot-failing-ci slack channel\n name: Report workflow run status to Slack\n uses: 8398a7/action-slack@fbd6aa58ba854a740e11a35d0df80cb5d12101d8 # v3.15.1\n with:\n status: ${{ job.status }}\n fields: repo,action,workflow\n text: 'AsyncAPI CLI release to BREW failed'\n env:\n SLACK_WEBHOOK_URL: ${{ secrets.SLACK_CI_FAIL_NOTIFY }}" }, { "path": ".github/workflows/bump.yml", "content": "# This action is centrally managed in https://github.com/asyncapi/.github/\n# 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\n\n# Purpose of this action is to update npm package in libraries that use it. It is like dependabot for asyncapi npm modules only. \n# It runs in a repo after merge of release commit and searches for other packages that use released package. Every found package gets updated with lates version\n\nname: Bump package version in dependent repos - if Node project\n\non:\n # It cannot run on release event as when release is created then version is not yet bumped in package.json\n # This means we cannot extract easily latest version and have a risk that package is not yet on npm\n push:\n branches:\n - master\n\njobs:\n bump-in-dependent-projects:\n name: Bump this package in repositories that depend on it\n if: startsWith(github.event.commits[0].message, 'chore(release):')\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repo\n uses: actions/checkout@v3\n - name: Check if Node.js project and has package.json\n id: packagejson\n run: test -e ./package.json && echo \"exists=true\" >> $GITHUB_OUTPUT || echo \"exists=false\" >> $GITHUB_OUTPUT\n - if: steps.packagejson.outputs.exists == 'true'\n name: Bumping latest version of this package in other repositories\n uses: derberg/npm-dependency-manager-for-your-github-org@1eafd3bf3974f21d395c1abac855cb04b295d570 # using v6.-.- https://github.com/derberg/npm-dependency-manager-for-your-github-org/releases/tag/v6\n with:\n github_token: ${{ secrets.GH_TOKEN }}\n committer_username: asyncapi-bot\n committer_email: info@asyncapi.io\n repos_to_ignore: spec,bindings,saunter,server-api\n custom_id: \"dependency update from asyncapi bot\"\n" }, { "path": ".github/workflows/deploy/chocolatey/asyncapi-cli.nuspec", "content": "\n\n\n \n asyncapi\n {{version}}\n https://github.com/asyncapi/cli/releases/v{{version}}\n AsyncAPI_Initiative\n\n \n \n asyncapi-cli\n AsyncAPI_Initiative\n https://www.asyncapi.com/\n https://avatars.githubusercontent.com/u/16401334?s=200\n 2023 AsyncAPI Initiative\n https://github.com/asyncapi/cli/blob/master/LICENSE\n false\n https://github.com/asyncapi/cli/releases/v{{version}}\n https://github.com/asyncapi/cli\n https://www.asyncapi.com/docs/tools/cli\n https://github.com/asyncapi/cli/issues/new/choose\n asyncapi-cli cli nodejs api asyncapi\n CLI to work with your AsyncAPI files. You can validate them and in the future use a generator and even bootstrap a new file. Contributions are welcomed!\n CLI to work with your AsyncAPI files. You can validate them and in the future use a generator and even bootstrap a new file. Contributions are welcomed!\n \n \n \n \n \n\n" }, { "path": ".github/workflows/deploy/chocolatey/replace.ps1", "content": "param (\n [Parameter(Mandatory=$true)]\n [string]$version,\n [string]$checksum,\n [string]$checksum64\n)\n\n$filePaths = @(\n './tools/chocolateyinstall.ps1'\n './asyncapi-cli.nuspec'\n)\n\nforeach ($filePath in $filePaths) {\n $fileContents = Get-Content $filePath\n $fileContents = $fileContents -replace '{{version}}', $version\n $fileContents = $fileContents -replace '{{checksum}}', $checksum\n $fileContents = $fileContents -replace '{{checksum64}}', $checksum64\n Set-Content $filePath $fileContents\n}" }, { "path": ".github/workflows/deploy/chocolatey/tools/chocolateyinstall.ps1", "content": "$ErrorActionPreference = 'Stop' # stop on all errors\n$toolsDir = \"$(Split-Path -parent $MyInvocation.MyCommand.Definition)\"\n\n$url = 'https://github.com/asyncapi/cli/releases/download/v{{version}}/asyncapi.x86.exe'\n$url64 = 'https://github.com/asyncapi/cli/releases/download/v{{version}}/asyncapi.x64.exe' \n\n$packageArgs = @{\n packageName = $env:ChocolateyPackageName\n unzipLocation = $toolsDir\n fileType = 'EXE' \n url = $url\n url64bit = $url64\n #file = $fileLocation NOTE: Commented out because we are using url instead\n\n softwareName = 'asyncapi-cli*'\n\n checksum = '{{checksum}}'\n checksumType = 'sha256' #default is md5, can also be sha1, sha256 or sha512\n checksum64 = '{{checksum64}}'\n checksumType64= 'sha256' #default is checksumType\n\n validExitCodes= @(0, 3010, 1641)\n silentArgs = '/S' # NSIS\n}\n\nInstall-ChocolateyPackage @packageArgs # https://docs.chocolatey.org/en-us/create/functions/install-chocolateypackage\n" }, { "path": ".github/workflows/help-command.yml", "content": "# This workflow is centrally managed in https://github.com/asyncapi/.github/\n# 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\n\nname: Create help comment\n\non: \n issue_comment:\n types: \n - created\n\npermissions: {}\n\njobs:\n create_help_comment_pr:\n name: Help Comment in PR\n if: ${{ github.event.issue.pull_request && startsWith(github.event.comment.body, '/help') && github.actor != 'asyncapi-bot' }}\n runs-on: ubuntu-latest\n permissions:\n pull-requests: write # To comment on Pull requests\n steps:\n - name: Add comment to PR\n uses: actions/github-script@v7\n env:\n ACTOR: ${{ github.actor }}\n with:\n github-token: ${{ github.token }}\n script: |\n //Yes to add comment to PR the same endpoint is use that we use to create a comment in issue\n //For more details http://developer.github.com/v3/issues/comments/\n //Also proved by this action https://github.com/actions-ecosystem/action-create-comment/blob/main/src/main.ts\n github.rest.issues.createComment({\n issue_number: context.issue.number,\n owner: context.repo.owner,\n repo: context.repo.repo,\n body: `Hello, @${process.env.ACTOR}! 👋🏼 \n\n I'm 🧞🧞🧞 Genie 🧞🧞🧞 from the magic lamp. Looks like somebody needs a hand!\n \n At the moment the following comments are supported in pull requests:\n \n - \\`/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.\n - \\`/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\n - \\`/do-not-merge\\` or \\`/dnm\\` - This comment will block automerging even if all conditions are met and ready-to-merge label is added\n - \\`/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. (Currently only works for upstream branches.)\n - \\`/update\\` or \\`/u\\` - This comment will update the PR with the latest changes from the target branch. Unless there is a merge conflict or it is a draft PR. NOTE: this only updates the PR once, so if you need to update again, you need to call the command again.`\n })\n\n create_help_comment_issue:\n name: Help Comment in Issue\n if: ${{ !github.event.issue.pull_request && startsWith(github.event.comment.body, '/help') && github.actor != 'asyncapi-bot' }}\n runs-on: ubuntu-latest\n permissions:\n issues: write # To comment on Issues\n steps:\n - name: Add comment to Issue\n uses: actions/github-script@v7\n env:\n ACTOR: ${{ github.actor }}\n with:\n github-token: ${{ github.token }}\n script: |\n github.rest.issues.createComment({\n issue_number: context.issue.number,\n owner: context.repo.owner,\n repo: context.repo.repo,\n body: `Hello, @${process.env.ACTOR}! 👋🏼 \n\n I'm 🧞🧞🧞 Genie 🧞🧞🧞 from the magic lamp. Looks like somebody needs a hand!\n \n At the moment the following comments are supported in issues:\n \n - \\`/good-first-issue {js | ts | java | go | docs | design | ci-cd}\\` or \\`/gfi {js | ts | java | go | docs | design | ci-cd}\\` - label an issue as a \\`good first issue\\`.\n example: \\`/gfi js\\` or \\`/good-first-issue ci-cd\\`\n - \\`/transfer-issue {repo-name}\\` or \\`/ti {repo-name}\\` - transfer issue from the source repository to the other repository passed by the user. example: \\`/ti cli\\` or \\`/transfer-issue cli\\`.`\n })" }, { "path": ".github/workflows/if-docker-pr-testing.yml", "content": "#This action is centrally managed in https://github.com/asyncapi/.github/\n#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\n#It does magic only if there is a Dockerfile in the root of the project\nname: PR testing - if Docker\n\non:\n pull_request:\n types: [opened, reopened, synchronize, ready_for_review]\n\nenv:\n IMAGE_NAME: ${{ github.repository }}\n\npermissions:\n contents: read\n\njobs:\n test-docker-pr:\n name: Test Docker build\n runs-on: ubuntu-latest\n\n steps:\n - if: >\n !github.event.pull_request.draft && !(\n (github.event.pull_request.user.login == 'asyncapi-bot' && (\n startsWith(github.event.pull_request.title, 'ci: update of files from global .github repo') || \n startsWith(github.event.pull_request.title, 'chore(release):')\n )) ||\n (github.event.pull_request.user.login == 'asyncapi-bot-eve' && (\n startsWith(github.event.pull_request.title, 'ci: update of files from global .github repo') || \n startsWith(github.event.pull_request.title, 'chore(release):')\n )) ||\n (github.event.pull_request.user.login == 'allcontributors[bot]' && \n startsWith(github.event.pull_request.title, 'docs: add')\n )\n )\n id: should_run\n name: Should Run\n run: echo \"shouldrun=true\" >> \"$GITHUB_OUTPUT\"\n\n - if: steps.should_run.outputs.shouldrun == 'true' \n name: Checkout repository\n uses: actions/checkout@v4\n with:\n persist-credentials: false\n\n - if: steps.should_run.outputs.shouldrun == 'true' \n name: Check if project has a Dockerfile\n id: docker\n run: test -e ./Dockerfile && echo \"exists=true\" >> \"$GITHUB_OUTPUT\" || echo \"exists=false\" >> \"$GITHUB_OUTPUT\"\n shell: bash\n\n - if: steps.docker.outputs.exists == 'true'\n name: Set up Docker Buildx\n uses: docker/setup-buildx-action@b5ca514318bd6ebac0fb2aedd5d36ec1b5c232a2 # use 3.10.0 https://github.com/docker/setup-buildx-action/releases/tag/v2.5.0\n\n - if: steps.docker.outputs.exists == 'true'\n name: Extract metadata for Docker\n id: meta\n uses: docker/metadata-action@902fa8ec7d6ecbf8d84d538b9b233a880e428804 # use 5.7.0 https://github.com/docker/metadata-action/releases/tag/v4.3.0\n with:\n images: ${{ env.IMAGE_NAME }}\n\n - if: steps.docker.outputs.exists == 'true'\n name: Build Docker image\n uses: docker/build-push-action@471d1dc4e07e5cdedd4c2171150001c434f0b7a4 # use 6.15.0 https://github.com/docker/build-push-action/releases/tag/v4.0.0\n with:\n context: .\n push: false\n tags: ${{ steps.meta.outputs.tags }}\n labels: ${{ steps.meta.outputs.labels }}\n cache-from: type=gha\n cache-to: type=gha,mode=max\n" }, { "path": ".github/workflows/if-nodejs-pr-testing.yml", "content": "# This action is centrally managed in https://github.com/asyncapi/.github/\n# 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\n\n# It does magic only if there is package.json file in the root of the project\nname: PR testing - if Node project\n\non:\n pull_request:\n types: [opened, reopened, synchronize, ready_for_review]\n\npermissions:\n contents: read\n\njobs:\n test-nodejs-pr:\n name: Test NodeJS PR - ${{ matrix.os }}\n runs-on: ${{ matrix.os }}\n strategy:\n matrix:\n os: [ubuntu-latest, macos-latest, windows-latest]\n steps:\n - if: >\n !github.event.pull_request.draft && !(\n (github.event.pull_request.user.login == 'asyncapi-bot' && (\n startsWith(github.event.pull_request.title, 'ci: update of files from global .github repo') || \n startsWith(github.event.pull_request.title, 'chore(release):')\n )) ||\n (github.event.pull_request.user.login == 'asyncapi-bot-eve' && (\n startsWith(github.event.pull_request.title, 'ci: update of files from global .github repo') || \n startsWith(github.event.pull_request.title, 'chore(release):')\n )) ||\n (github.event.pull_request.user.login == 'allcontributors[bot]' && \n startsWith(github.event.pull_request.title, 'docs: add')\n )\n )\n id: should_run\n name: Should Run\n run: echo \"shouldrun=true\" >> \"$GITHUB_OUTPUT\"\n shell: bash\n - if: steps.should_run.outputs.shouldrun == 'true' \n name: Set git to use LF #to once and for all finish neverending fight between Unix and Windows\n run: |\n git config --global core.autocrlf false\n git config --global core.eol lf\n shell: bash\n - if: steps.should_run.outputs.shouldrun == 'true' \n name: Checkout repository\n uses: actions/checkout@v4\n with:\n persist-credentials: false\n - if: steps.should_run.outputs.shouldrun == 'true' \n name: Check if Node.js project and has package.json\n id: packagejson\n run: test -e ./package.json && echo \"exists=true\" >> \"$GITHUB_OUTPUT\" || echo \"exists=false\" >> \"$GITHUB_OUTPUT\"\n shell: bash\n - if: steps.packagejson.outputs.exists == 'true'\n name: Determine what node version to use\n # This workflow is from our own org repo and safe to reference by 'master'.\n uses: asyncapi/.github/.github/actions/get-node-version-from-package-lock@master # //NOSONAR\n with:\n node-version: ${{ vars.NODE_VERSION }}\n id: lockversion\n - if: steps.packagejson.outputs.exists == 'true'\n name: Setup Node.js\n uses: actions/setup-node@v4\n with:\n node-version: \"${{ steps.lockversion.outputs.version }}\"\n - if: steps.lockversion.outputs.version == '18' && matrix.os == 'windows-latest'\n #npm cli 10 is buggy because of some cache issue\n name: Install npm cli 8\n shell: bash\n run: npm install -g npm@8.19.4\n - if: steps.packagejson.outputs.exists == 'true'\n name: Install dependencies\n shell: bash\n run: npm ci\n - if: steps.packagejson.outputs.exists == 'true'\n name: Test\n run: npm test --if-present\n - if: steps.packagejson.outputs.exists == 'true' && matrix.os == 'ubuntu-latest'\n #linting should run just one and not on all possible operating systems\n name: Run linter\n run: npm run lint --if-present\n - if: steps.packagejson.outputs.exists == 'true'\n name: Run release assets generation to make sure PR does not break it\n shell: bash\n run: npm run generate:assets --if-present\n" }, { "path": ".github/workflows/issues-prs-notifications.yml", "content": "# This action is centrally managed in https://github.com/asyncapi/.github/\n# 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\n\n# This action notifies community on slack whenever there is a new issue, PR or discussion started in given repository\nname: Notify slack\n\non:\n issues:\n types: [opened, reopened]\n\n pull_request_target:\n types: [opened, reopened, ready_for_review] # zizmor: ignore[dangerous-triggers] \n\n discussion:\n types: [created]\n\npermissions: {}\n\njobs:\n issue:\n if: github.event_name == 'issues' && github.actor != 'asyncapi-bot' && github.actor != 'dependabot[bot]' && github.actor != 'dependabot-preview[bot]'\n name: Notify slack on every new issue\n runs-on: ubuntu-latest\n steps:\n - name: Convert markdown to slack markdown for issue\n # This workflow is from our own org repo and safe to reference by 'master'.\n uses: asyncapi/.github/.github/actions/slackify-markdown@master # //NOSONAR\n id: issuemarkdown\n env:\n ISSUE_TITLE: ${{github.event.issue.title}}\n ISSUE_URL: ${{github.event.issue.html_url}}\n ISSUE_BODY: ${{github.event.issue.body}}\n with:\n markdown: \"[${{ env.ISSUE_TITLE }}](${{ env.ISSUE_URL }}) \\n ${{ env.ISSUE_BODY }}\"\n - name: Send info about issue\n uses: rtCamp/action-slack-notify@c33737706dea87cd7784c687dadc9adf1be59990 # Using v2.3.2\n env:\n SLACK_WEBHOOK: ${{secrets.SLACK_GITHUB_NEWISSUEPR}}\n SLACK_TITLE: 🐛 New Issue in ${{github.repository}} 🐛\n SLACK_MESSAGE: ${{steps.issuemarkdown.outputs.text}}\n MSG_MINIMAL: true\n\n pull_request:\n if: github.event_name == 'pull_request_target' && github.actor != 'asyncapi-bot' && github.actor != 'dependabot[bot]' && github.actor != 'dependabot-preview[bot]'\n name: Notify slack on every new pull request\n runs-on: ubuntu-latest\n steps:\n - name: Convert markdown to slack markdown for pull request\n # This workflow is from our own org repo and safe to reference by 'master'.\n uses: asyncapi/.github/.github/actions/slackify-markdown@master # //NOSONAR\n id: prmarkdown\n env:\n PR_TITLE: ${{github.event.pull_request.title}}\n PR_URL: ${{github.event.pull_request.html_url}}\n PR_BODY: ${{github.event.pull_request.body}}\n with:\n markdown: \"[${{ env.PR_TITLE }}](${{ env.PR_URL }}) \\n ${{ env.PR_BODY }}\"\n - name: Send info about pull request\n uses: rtCamp/action-slack-notify@c33737706dea87cd7784c687dadc9adf1be59990 # Using v2.3.2\n env:\n SLACK_WEBHOOK: ${{secrets.SLACK_GITHUB_NEWISSUEPR}}\n SLACK_TITLE: 💪 New Pull Request in ${{github.repository}} 💪\n SLACK_MESSAGE: ${{steps.prmarkdown.outputs.text}}\n MSG_MINIMAL: true\n\n discussion:\n if: github.event_name == 'discussion' && github.actor != 'asyncapi-bot' && github.actor != 'dependabot[bot]' && github.actor != 'dependabot-preview[bot]'\n name: Notify slack on every new pull request\n runs-on: ubuntu-latest\n steps:\n - name: Convert markdown to slack markdown for pull request\n # This workflow is from our own org repo and safe to reference by 'master'.\n uses: asyncapi/.github/.github/actions/slackify-markdown@master # //NOSONAR\n id: discussionmarkdown\n env:\n DISCUSSION_TITLE: ${{github.event.discussion.title}}\n DISCUSSION_URL: ${{github.event.discussion.html_url}}\n DISCUSSION_BODY: ${{github.event.discussion.body}}\n with:\n markdown: \"[${{ env.DISCUSSION_TITLE }}](${{ env.DISCUSSION_URL }}) \\n ${{ env.DISCUSSION_BODY }}\"\n - name: Send info about pull request\n uses: rtCamp/action-slack-notify@c33737706dea87cd7784c687dadc9adf1be59990 # Using v2.3.2\n env:\n SLACK_WEBHOOK: ${{secrets.SLACK_GITHUB_NEWISSUEPR}}\n SLACK_TITLE: 💬 New Discussion in ${{github.repository}} 💬\n SLACK_MESSAGE: ${{steps.discussionmarkdown.outputs.text}}\n MSG_MINIMAL: true\n" }, { "path": ".github/workflows/lint-pr-title.yml", "content": "# This action is centrally managed in https://github.com/asyncapi/.github/\n# 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\n\nname: Lint PR title\n\non:\n pull_request:\n types: [opened, reopened, synchronize, edited, ready_for_review]\n\npermissions: {}\n\njobs:\n lint-pr-title:\n name: Lint PR title\n runs-on: ubuntu-latest\n permissions:\n contents: read # To checkout code and read PR information\n pull-requests: write # To comment on PR if the title is not valid\n steps:\n # Since this workflow is REQUIRED for a PR to be mergable, we have to have this 'if' statement in step level instead of job level.\n - if: ${{ !contains(fromJson('[\"asyncapi-bot\", \"dependabot[bot]\", \"dependabot-preview[bot]\", \"allcontributors[bot]\"]'), github.actor) }} # zizmor: ignore[obfuscation]\n uses: amannn/action-semantic-pull-request@c3cd5d1ea3580753008872425915e343e351ab54 #version 5.2.0 https://github.com/amannn/action-semantic-pull-request/releases/tag/v5.2.0\n id: lint_pr_title\n env:\n GITHUB_TOKEN: ${{ github.token }}\n with:\n subjectPattern: ^(?![A-Z]).+$\n subjectPatternError: |\n The subject \"{subject}\" found in the pull request title \"{title}\" should start with a lowercase character.\n\n # Comments the error message from the above lint_pr_title action\n - if: ${{ always() && steps.lint_pr_title.outputs.error_message != null && !contains(fromJson('[\"asyncapi-bot\", \"dependabot[bot]\", \"dependabot-preview[bot]\", \"allcontributors[bot]\"]'), github.actor)}} # zizmor: ignore[obfuscation]\n name: Comment on PR\n uses: marocchino/sticky-pull-request-comment@3d60a5b2dae89d44e0c6ddc69dd7536aec2071cd #use 2.5.0 https://github.com/marocchino/sticky-pull-request-comment/releases/tag/v2.5.0\n with:\n header: pr-title-lint-error\n GITHUB_TOKEN: ${{ github.token }}\n message: |\n\n We require all PRs to follow [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/). \n More details 👇🏼\n ```\n ${{ steps.lint_pr_title.outputs.error_message}}\n ```\n # deletes the error comment if the title is correct\n - if: ${{ steps.lint_pr_title.outputs.error_message == null }}\n name: delete the comment\n uses: marocchino/sticky-pull-request-comment@3d60a5b2dae89d44e0c6ddc69dd7536aec2071cd #use 2.5.0 https://github.com/marocchino/sticky-pull-request-comment/releases/tag/v2.5.0\n with:\n header: pr-title-lint-error\n delete: true\n GITHUB_TOKEN: ${{ github.token }}\n" }, { "path": ".github/workflows/notify-tsc-members-mention.yml", "content": "# This action is centrally managed in https://github.com/asyncapi/.github/\n# 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\n\n# This action notifies community on slack whenever there is a new issue, PR or discussion started in given repository\nname: Notify slack and email subscribers whenever TSC members are mentioned in GitHub\n\non:\n issue_comment:\n types:\n - created\n\n discussion_comment:\n types:\n - created\n\n issues:\n types:\n - opened\n\n pull_request_target: # Needed to access secrets. The checkout is done on base branch so script cannot be malicious.\n types:\n - opened # zizmor: ignore[dangerous-triggers]\n discussion:\n types:\n - created\n\npermissions:\n contents: read # To checkout repository\n\njobs:\n issue:\n if: github.event_name == 'issues' && contains(github.event.issue.body, '@asyncapi/tsc_members')\n name: TSC notification on every new issue\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n with:\n persist-credentials: false\n - name: Setup Node.js\n uses: actions/setup-node@v4\n with:\n node-version: 20\n cache: 'npm'\n cache-dependency-path: '**/package-lock.json'\n #########\n # Handling Slack notifications\n #########\n - name: Convert markdown to slack markdown\n # This workflow is from our own org repo and safe to reference by 'master'.\n uses: asyncapi/.github/.github/actions/slackify-markdown@master # //NOSONAR\n id: issuemarkdown\n with:\n markdown: \"[${{github.event.issue.title}}](${{github.event.issue.html_url}}) \\n ${{github.event.issue.body}}\"\n - name: Send info about issue\n uses: rtCamp/action-slack-notify@c33737706dea87cd7784c687dadc9adf1be59990 # Using v2.3.2\n env:\n SLACK_WEBHOOK: ${{secrets.SLACK_TSC_MEMBERS_NOTIFY}}\n SLACK_TITLE: 🆘 New issue that requires TSC Members attention 🆘\n SLACK_MESSAGE: ${{steps.issuemarkdown.outputs.text}}\n MSG_MINIMAL: true\n #########\n # Handling Kit.com notifications\n #########\n - name: Install deps\n run: npm install\n working-directory: ./.github/workflows/scripts/kit\n - name: Send email with Kit.com\n uses: actions/github-script@v7\n env:\n KIT_API_KEY: ${{ secrets.KIT_API_KEY }}\n KIT_TSC_TAG_ID: ${{ secrets.KIT_TSC_TAG_ID }}\n TITLE: ${{ github.event.issue.title }}\n HTML_URL: ${{ github.event.issue.html_url }}\n with:\n script: |\n const sendEmail = require('./.github/workflows/scripts/kit/index.js');\n return sendEmail(process.env.HTML_URL, process.env.TITLE);\n\n pull_request:\n if: github.event_name == 'pull_request_target' && contains(github.event.pull_request.body, '@asyncapi/tsc_members')\n name: TSC notification on every new pull request\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n with:\n persist-credentials: false\n - name: Setup Node.js\n uses: actions/setup-node@v4\n with:\n node-version: 20\n cache: 'npm'\n cache-dependency-path: '**/package-lock.json'\n #########\n # Handling Slack notifications\n #########\n - name: Convert markdown to slack markdown\n # This workflow is from our own org repo and safe to reference by 'master'.\n uses: asyncapi/.github/.github/actions/slackify-markdown@master # //NOSONAR\n id: prmarkdown\n with:\n markdown: \"[${{github.event.pull_request.title}}](${{github.event.pull_request.html_url}}) \\n ${{github.event.pull_request.body}}\"\n - name: Send info about pull request\n uses: rtCamp/action-slack-notify@c33737706dea87cd7784c687dadc9adf1be59990 # Using v2.3.2\n env:\n SLACK_WEBHOOK: ${{secrets.SLACK_TSC_MEMBERS_NOTIFY}}\n SLACK_TITLE: 🆘 New PR that requires TSC Members attention 🆘\n SLACK_MESSAGE: ${{steps.prmarkdown.outputs.text}}\n MSG_MINIMAL: true\n #########\n # Handling Kit.com notifications\n #########\n - name: Install deps\n run: npm install\n working-directory: ./.github/workflows/scripts/kit\n - name: Send email with Kit.com\n uses: actions/github-script@v7\n env:\n KIT_API_KEY: ${{ secrets.KIT_API_KEY }}\n KIT_TSC_TAG_ID: ${{ secrets.KIT_TSC_TAG_ID }}\n TITLE: ${{ github.event.pull_request.title }}\n HTML_URL: ${{ github.event.pull_request.html_url }}\n with:\n script: |\n const sendEmail = require('./.github/workflows/scripts/kit/index.js');\n return sendEmail(process.env.HTML_URL, process.env.TITLE);\n\n discussion:\n if: github.event_name == 'discussion' && contains(github.event.discussion.body, '@asyncapi/tsc_members')\n name: TSC notification on every new discussion\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n with:\n persist-credentials: false\n - name: Setup Node.js\n uses: actions/setup-node@v4\n with:\n node-version: 20\n cache: 'npm'\n cache-dependency-path: '**/package-lock.json'\n #########\n # Handling Slack notifications\n #########\n - name: Convert markdown to slack markdown\n # This workflow is from our own org repo and safe to reference by 'master'.\n uses: asyncapi/.github/.github/actions/slackify-markdown@master # //NOSONAR\n id: discussionmarkdown\n with:\n markdown: \"[${{github.event.discussion.title}}](${{github.event.discussion.html_url}}) \\n ${{github.event.discussion.body}}\"\n - name: Send info about discussion\n uses: rtCamp/action-slack-notify@c33737706dea87cd7784c687dadc9adf1be59990 # Using v2.3.2\n env:\n SLACK_WEBHOOK: ${{secrets.SLACK_TSC_MEMBERS_NOTIFY}}\n SLACK_TITLE: 🆘 New discussion that requires TSC Members attention 🆘\n SLACK_MESSAGE: ${{steps.discussionmarkdown.outputs.text}}\n MSG_MINIMAL: true\n #########\n # Handling Kit.com notifications\n #########\n - name: Install deps\n run: npm install\n working-directory: ./.github/workflows/scripts/kit\n - name: Send email with Kit.com\n uses: actions/github-script@v7\n env:\n KIT_API_KEY: ${{ secrets.KIT_API_KEY }}\n KIT_TSC_TAG_ID: ${{ secrets.KIT_TSC_TAG_ID }}\n TITLE: ${{ github.event.discussion.title }}\n HTML_URL: ${{ github.event.discussion.html_url }}\n with:\n script: |\n const sendEmail = require('./.github/workflows/scripts/kit/index.js');\n return sendEmail(process.env.HTML_URL, process.env.TITLE);\n\n issue_comment:\n if: ${{ github.event_name == 'issue_comment' && !github.event.issue.pull_request && contains(github.event.comment.body, '@asyncapi/tsc_members') }}\n name: TSC notification on every new comment in issue\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n with:\n persist-credentials: false\n - name: Setup Node.js\n uses: actions/setup-node@v4\n with:\n node-version: 20\n cache: 'npm'\n cache-dependency-path: '**/package-lock.json'\n #########\n # Handling Slack notifications\n #########\n - name: Convert markdown to slack markdown\n # This workflow is from our own org repo and safe to reference by 'master'.\n uses: asyncapi/.github/.github/actions/slackify-markdown@master # //NOSONAR\n id: issuemarkdown\n with:\n markdown: \"[${{github.event.issue.title}}](${{github.event.comment.html_url}}) \\n ${{github.event.comment.body}}\"\n - name: Send info about issue comment\n uses: rtCamp/action-slack-notify@c33737706dea87cd7784c687dadc9adf1be59990 # Using v2.3.2\n env:\n SLACK_WEBHOOK: ${{secrets.SLACK_TSC_MEMBERS_NOTIFY}}\n SLACK_TITLE: 🆘 New comment under existing issue that requires TSC Members attention 🆘\n SLACK_MESSAGE: ${{steps.issuemarkdown.outputs.text}}\n MSG_MINIMAL: true\n #########\n # Handling Kit.com notifications\n #########\n - name: Install deps\n run: npm install\n working-directory: ./.github/workflows/scripts/kit\n - name: Send email with Kit.com\n uses: actions/github-script@v7\n env:\n KIT_API_KEY: ${{ secrets.KIT_API_KEY }}\n KIT_TSC_TAG_ID: ${{ secrets.KIT_TSC_TAG_ID }}\n TITLE: ${{ github.event.issue.title }}\n HTML_URL: ${{ github.event.comment.html_url }}\n with:\n script: |\n const sendEmail = require('./.github/workflows/scripts/kit/index.js');\n return sendEmail(process.env.HTML_URL, process.env.TITLE);\n\n pr_comment:\n if: github.event_name == 'issue_comment' && github.event.issue.pull_request && contains(github.event.comment.body, '@asyncapi/tsc_members')\n name: TSC notification on every new comment in pr\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n with:\n persist-credentials: false\n - name: Setup Node.js\n uses: actions/setup-node@v4\n with:\n node-version: 20\n cache: 'npm'\n cache-dependency-path: '**/package-lock.json'\n #########\n # Handling Slack notifications\n #########\n - name: Convert markdown to slack markdown\n # This workflow is from our own org repo and safe to reference by 'master'.\n uses: asyncapi/.github/.github/actions/slackify-markdown@master # //NOSONAR\n id: prmarkdown\n with:\n markdown: \"[${{github.event.issue.title}}](${{github.event.comment.html_url}}) \\n ${{github.event.comment.body}}\"\n - name: Send info about PR comment\n uses: rtCamp/action-slack-notify@c33737706dea87cd7784c687dadc9adf1be59990 # Using v2.3.2\n env:\n SLACK_WEBHOOK: ${{secrets.SLACK_TSC_MEMBERS_NOTIFY}}\n SLACK_TITLE: 🆘 New comment under existing PR that requires TSC Members attention 🆘\n SLACK_MESSAGE: ${{steps.prmarkdown.outputs.text}}\n MSG_MINIMAL: true\n #########\n # Handling Kit.com notifications\n #########\n - name: Install deps\n run: npm install\n working-directory: ./.github/workflows/scripts/kit\n - name: Send email with Kit.com\n uses: actions/github-script@v7\n env:\n KIT_API_KEY: ${{ secrets.KIT_API_KEY }}\n KIT_TSC_TAG_ID: ${{ secrets.KIT_TSC_TAG_ID }}\n TITLE: ${{ github.event.issue.title }}\n HTML_URL: ${{ github.event.comment.html_url }}\n with:\n script: |\n const sendEmail = require('./.github/workflows/scripts/kit/index.js');\n return sendEmail(process.env.HTML_URL, process.env.TITLE);\n\n discussion_comment:\n if: github.event_name == 'discussion_comment' && contains(github.event.comment.body, '@asyncapi/tsc_members')\n name: TSC notification on every new comment in discussion\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n with:\n persist-credentials: false\n - name: Setup Node.js\n uses: actions/setup-node@v4\n with:\n node-version: 20\n cache: 'npm'\n cache-dependency-path: '**/package-lock.json'\n #########\n # Handling Slack notifications\n #########\n - name: Convert markdown to slack markdown\n # This workflow is from our own org repo and safe to reference by 'master'.\n uses: asyncapi/.github/.github/actions/slackify-markdown@master # //NOSONAR\n id: discussionmarkdown\n with:\n markdown: \"[${{github.event.discussion.title}}](${{github.event.comment.html_url}}) \\n ${{github.event.comment.body}}\"\n - name: Send info about discussion comment\n uses: rtCamp/action-slack-notify@c33737706dea87cd7784c687dadc9adf1be59990 # Using v2.3.2\n env:\n SLACK_WEBHOOK: ${{secrets.SLACK_TSC_MEMBERS_NOTIFY}}\n SLACK_TITLE: 🆘 New comment under existing discussion that requires TSC Members attention 🆘\n SLACK_MESSAGE: ${{steps.discussionmarkdown.outputs.text}}\n MSG_MINIMAL: true\n #########\n # Handling Kit.com notifications\n #########\n - name: Install deps\n run: npm install\n working-directory: ./.github/workflows/scripts/kit\n - name: Send email with Kit.com\n uses: actions/github-script@v7\n env:\n KIT_API_KEY: ${{ secrets.KIT_API_KEY }}\n KIT_TSC_TAG_ID: ${{ secrets.KIT_TSC_TAG_ID }}\n TITLE: ${{ github.event.discussion.title }}\n HTML_URL: ${{ github.event.comment.html_url }}\n with:\n script: |\n const sendEmail = require('./.github/workflows/scripts/kit/index.js');\n return sendEmail(process.env.HTML_URL, process.env.TITLE);\n" }, { "path": ".github/workflows/please-take-a-look-command.yml", "content": "# This action is centrally managed in https://github.com/asyncapi/.github/\n# 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\n\n# It uses Github actions to listen for comments on issues and pull requests and \n# if the comment contains /please-take-a-look or /ptal it will add a comment pinging \n# the code-owners who are reviewers for PR\n\nname: Please take a Look\n\non:\n issue_comment:\n types: [created]\n\npermissions: {}\n\njobs:\n ping-for-attention:\n if: >\n github.event.issue.pull_request &&\n github.event.issue.state != 'closed' &&\n github.actor != 'asyncapi-bot' &&\n (\n contains(github.event.comment.body, '/please-take-a-look') ||\n contains(github.event.comment.body, '/ptal') ||\n contains(github.event.comment.body, '/PTAL') \n )\n name: Ping code owners for attention\n runs-on: ubuntu-latest\n steps:\n - name: Check for Please Take a Look Command\n uses: actions/github-script@v7\n with:\n github-token: ${{ secrets.GH_TOKEN }}\n script: |\n const prDetailsUrl = context.payload.issue.pull_request.url;\n const { data: pull } = await github.request(prDetailsUrl);\n const reviewers = (pull.requested_reviewers || []).map(reviewer => reviewer.login);\n\n const { data: reviews } = await github.rest.pulls.listReviews({\n owner: context.repo.owner,\n repo: context.repo.repo,\n pull_number: context.issue.number\n });\n\n const reviewersWhoHaveReviewed = reviews.map(review => review.user.login);\n\n const reviewersWhoHaveNotReviewed = reviewers.filter(reviewer => !reviewersWhoHaveReviewed.includes(reviewer));\n\n if (reviewersWhoHaveNotReviewed.length > 0) {\n const comment = reviewersWhoHaveNotReviewed.filter(reviewer => reviewer !== 'asyncapi-bot-eve' ).map(reviewer => `@${reviewer}`).join(' ');\n await github.rest.issues.createComment({\n issue_number: context.issue.number,\n owner: context.repo.owner,\n repo: context.repo.repo,\n body: `${comment} Please take a look at this PR. Thanks! :wave:`\n });\n }\n" }, { "path": ".github/workflows/release-announcements.yml", "content": "# This action is centrally managed in https://github.com/asyncapi/.github/\n# 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\n\nname: 'Announce releases in different channels'\n\non: \n release:\n types: \n - published\n\npermissions:\n contents: read # To checkout code and read release information\n\njobs:\n\n slack-announce:\n name: Slack - notify on every release\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n with:\n persist-credentials: false\n - name: Convert markdown to slack markdown for issue\n # This workflow is from our own org repo and safe to reference by 'master'.\n uses: asyncapi/.github/.github/actions/slackify-markdown@master # //NOSONAR\n id: markdown\n env:\n RELEASE_TAG: ${{github.event.release.tag_name}}\n RELEASE_URL: ${{github.event.release.html_url}}\n RELEASE_BODY: ${{ github.event.release.body }}\n with:\n markdown: \"[${{ env.RELEASE_TAG }}](${{ env.RELEASE_URL }}) \\n ${{ env.RELEASE_BODY }}\"\n - name: Send info about release to Slack\n uses: rtCamp/action-slack-notify@c33737706dea87cd7784c687dadc9adf1be59990 # Using v2.3.2\n env:\n SLACK_WEBHOOK: ${{ secrets.SLACK_RELEASES }}\n SLACK_TITLE: Release ${{ env.RELEASE_TAG }} for ${{ env.REPO_NAME }} is out in the wild 😱💪🍾🎂\n SLACK_MESSAGE: ${{steps.markdown.outputs.text}}\n MSG_MINIMAL: true\n RELEASE_TAG: ${{github.event.release.tag_name}}\n REPO_NAME: ${{github.repository}}\n\n twitter-announce:\n name: Twitter - notify on minor and major releases\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repo\n uses: actions/checkout@v4\n with:\n persist-credentials: false\n - name: Get version of last and previous release\n uses: actions/github-script@v7\n id: versions\n with:\n github-token: ${{ github.token }}\n script: |\n const query = `query($owner:String!, $name:String!) {\n repository(owner:$owner, name:$name){\n releases(first: 2, orderBy: {field: CREATED_AT, direction: DESC}) {\n nodes {\n name\n }\n }\n }\n }`;\n const variables = {\n owner: context.repo.owner,\n name: context.repo.repo\n };\n const { repository: { releases: { nodes } } } = await github.graphql(query, variables);\n core.setOutput('lastver', nodes[0].name);\n // In case of first release in the package, there is no such thing as previous error, so we set info about previous version only once we have it\n // We should tweet about the release no matter of the type as it is initial release\n if (nodes.length != 1) core.setOutput('previousver', nodes[1].name);\n - name: Identify release type\n id: releasetype\n # if previousver is not provided then this steps just logs information about missing version, no errors\n env:\n PREV_VERSION: ${{steps.versions.outputs.previousver}}\n LAST_VERSION: ${{steps.versions.outputs.lastver}}\n run: echo \"type=$(npx -q -p semver-diff-cli semver-diff \"$PREV_VERSION\" \"$LAST_VERSION\")\" >> \"$GITHUB_OUTPUT\"\n - name: Get name of the person that is behind the newly released version\n id: author\n run: |\n AUTHOR_NAME=$(git log -1 --pretty=format:'%an')\n printf 'name=%s\\n' \"$AUTHOR_NAME\" >> \"$GITHUB_OUTPUT\"\n - name: Publish information about the release to Twitter # tweet only if detected version change is not a patch\n # tweet goes out even if the type is not major or minor but \"You need provide version number to compare.\"\n # it is ok, it just means we did not identify previous version as we are tweeting out information about the release for the first time\n if: steps.releasetype.outputs.type != 'null' && steps.releasetype.outputs.type != 'patch' # null means that versions are the same\n uses: m1ner79/Github-Twittction@d1e508b6c2170145127138f93c49b7c46c6ff3a7 # using 2.0.0 https://github.com/m1ner79/Github-Twittction/releases/tag/v2.0.0\n env:\n RELEASE_TAG: ${{github.event.release.tag_name}}\n REPO_NAME: ${{github.repository}}\n AUTHOR_NAME: ${{ steps.author.outputs.name }}\n RELEASE_URL: ${{github.event.release.html_url}}\n with:\n twitter_status: \"Release ${{ env.RELEASE_TAG }} for ${{ env.REPO_NAME }} is out in the wild 😱💪🍾🎂\\n\\nThank you for the contribution ${{ env.AUTHOR_NAME }} ${{ env.RELEASE_URL }}\"\n twitter_consumer_key: ${{ secrets.TWITTER_CONSUMER_KEY }} \n twitter_consumer_secret: ${{ secrets.TWITTER_CONSUMER_SECRET }} \n twitter_access_token_key: ${{ secrets.TWITTER_ACCESS_TOKEN_KEY }} \n twitter_access_token_secret: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}" }, { "path": ".github/workflows/release-chocolatey.yml", "content": "name: Release Chocolatey Package\non:\n # We cannot run chocolatey release continusly every time we release something as sometimes we release a couple of times a day and overload chocolatey pipelines\n # More details https://github.com/asyncapi/cli/issues/503\n schedule:\n - cron: '0 23 * * *' # Run every day at 23:00 UTC\n # Since now release depends on schedule, might be that there is a situation we cannot wait for schedule and trigger release manually\n workflow_dispatch:\n inputs:\n version:\n description: 'Version to release (optional)'\n required: false\n \njobs:\n release:\n name: Publish to Chocolatey Community\n runs-on: windows-latest\n steps:\n - name: Checkout\n uses: actions/checkout@v3\n\n - name: Set Version\n id: release_version\n run: |\n if ( \"${{ github.event_name }}\" -eq \"workflow_dispatch\" -and \"${{ github.event.inputs.version }}\" -ne \"\" ) {\n $version = \"${{ github.event.inputs.version }}\"\n }\n else {\n $version = $(npm pkg get version)\n }\n\n $version = $version.Replace(\"`\"\", \"\")\n echo \"Setting version to $version\"\n echo \"version=$version\" >> $env:GITHUB_OUTPUT\n\n - name: Check if this is a new version to release\n id: check_new_version\n run: |\n $output = choco search asyncapi-cli --version=${{ steps.release_version.outputs.version }}\n # Output is of the form:\n # Chocolatey v2.2.2\n # asyncapi-cli 0.0.1 [Approved]\n # 1 packages found.\n # If the version is not found, the output will of the form:\n # Chocolatey v2.2.2\n # 0 packages found.\n\n if ($output -match \"0 packages found.\") {\n echo \"This is a new version to release\"\n echo \"new_version=true\" >> $env:GITHUB_OUTPUT\n }\n else {\n echo \"This is not a new version to release\"\n echo \"new_version=false\" >> $env:GITHUB_OUTPUT\n }\n \n - name: Download release\n if: steps.check_new_version.outputs.new_version == 'true'\n run: |\n echo \"Downloading release assets for version ${{ steps.release_version.outputs.version }}\"\n mkdir -p ./dist/win32\n curl -L \"https://github.com/asyncapi/cli/releases/download/v${{ steps.release_version.outputs.version }}/asyncapi.x64.exe\" -o \"./dist/win32/asyncapi.x64.exe\"\n curl -L \"https://github.com/asyncapi/cli/releases/download/v${{ steps.release_version.outputs.version }}/asyncapi.x86.exe\" -o \"./dist/win32/asyncapi.x86.exe\"\n\n - name: Get Checksum of the release\n if: steps.check_new_version.outputs.new_version == 'true'\n id: release_checksum\n run: |\n $checksum = (Get-FileHash -Path \"./dist/win32/asyncapi.x86.exe\" -Algorithm SHA256).Hash\n $checksum64 = (Get-FileHash -Path \"./dist/win32/asyncapi.x64.exe\" -Algorithm SHA256).Hash\n echo \"Setting checksum to $checksum\"\n echo \"checksum=$checksum\" >> $env:GITHUB_OUTPUT\n echo \"Setting checksum64 to $checksum64\"\n echo \"checksum64=$checksum64\" >> $env:GITHUB_OUTPUT\n\n - name: Make nuspec from the template\n if: steps.check_new_version.outputs.new_version == 'true'\n run: |\n cd ./.github/workflows/deploy/chocolatey\n pwsh -File ./replace.ps1 -version ${{ steps.release_version.outputs.version }} -checksum ${{ steps.release_checksum.outputs.checksum }} -checksum64 ${{ steps.release_checksum.outputs.checksum64 }}\n\n - name: Run Chocolatey Pack\n if: steps.check_new_version.outputs.new_version == 'true'\n run: |\n cd ./.github/workflows/deploy/chocolatey\n choco pack ./asyncapi-cli.nuspec\n choco apikey add --source \"'https://push.chocolatey.org/'\" --key ${{ secrets.CHOCOLATEY_API_KEY }}\n choco push ./asyncapi.${{ steps.release_version.outputs.version }}.nupkg --source \"'https://push.chocolatey.org/'\" \n \n - if: failure() # Only, on failure, send a message on the 94_bot-failing-ci slack channel\n name: Report workflow run status to Slack\n uses: 8398a7/action-slack@fbd6aa58ba854a740e11a35d0df80cb5d12101d8 #using https://github.com/8398a7/action-slack/releases/tag/v3.15.1\n with:\n status: ${{ job.status }}\n fields: repo,action,workflow\n text: 'AsyncAPI CLI release to Chocolatey failed'\n env:\n SLACK_WEBHOOK_URL: ${{ secrets.SLACK_CI_FAIL_NOTIFY }}" }, { "path": ".github/workflows/release-docker.yml", "content": "name: Release Docker Image\non:\n release:\n types:\n - published\n\njobs:\n publish-docker:\n name: Generating Docker\n runs-on: ubuntu-latest\n steps:\n - name: Get version without v character\n id: version\n env:\n TAG_NAME: ${{ github.event.release.tag_name }}\n run: |\n VERSION_WITHOUT_V=${TAG_NAME:1}\n echo \"value=${VERSION_WITHOUT_V}\" >> $GITHUB_OUTPUT\n\n - name : Checkout repository\n uses: actions/checkout@v4\n with:\n ref: ${{ github.event.release.tag_name }}\n\n - name: Set Up QEMU\n uses: docker/setup-qemu-action@68827325e0b33c7199eb31dd4e31fbe9023e06e3 # v3.0.0\n\n - name: Set Up Docker Buildx\n uses: docker/setup-buildx-action@d70bba72b1f3fd22344832f00baa16ece964efeb # v3.3.0\n\n - name: login to Docker Hub\n uses: docker/login-action@e92390c5fb421da1463c202d546fed0ec5c39f20 # v3.1.0\n with:\n username: ${{ secrets.DOCKER_USERNAME }}\n password: ${{ secrets.DOCKER_PASSWORD }}\n\n - name: Build Image\n uses: docker/build-push-action@2cdde995de11925a030ce8070c3d77a52ffcf1c0 # v5.3.0\n with:\n push: true\n load: false\n build-args: |\n ASYNCAPI_CLI_VERSION=${{ steps.version.outputs.value }}\n tags: |\n asyncapi/cli:${{ steps.version.outputs.value }}\n asyncapi/cli:latest\n platforms: linux/amd64,linux/arm64\n cache-from: type=gha\n cache-to: type=gha\n\n - name: Sync README.md and Description to Docker Hub\n uses: actions/checkout@v4\n\n - uses: meeDamian/sync-readme@82715041300710d9be7c726c9d6c683b70451087 # v1.0.6\n with:\n user: ${{ secrets.DOCKER_USERNAME }}\n pass: ${{ secrets.DOCKER_PASSWORD }}\n slug: asyncapi/cli\n description: CLI to work with your AsyncAPI files\n\n publish-action-docker:\n name: Release github action for cli and update version in action.yml\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n with:\n ref: ${{ github.event.release.tag_name }}\n\n - name: Get version without v character\n id: version\n env:\n TAG_NAME: ${{ github.event.release.tag_name }}\n run: |\n VERSION_WITHOUT_V=${TAG_NAME:1}\n echo \"value=${VERSION_WITHOUT_V}\" >> $GITHUB_OUTPUT\n\n - name: Set Up QEMU\n uses: docker/setup-qemu-action@68827325e0b33c7199eb31dd4e31fbe9023e06e3 # v3.0.0\n\n - name: Set Up Docker Buildx\n uses: docker/setup-buildx-action@d70bba72b1f3fd22344832f00baa16ece964efeb # v3.3.0\n\n - name: Login to Docker Hub\n uses: docker/login-action@e92390c5fb421da1463c202d546fed0ec5c39f20 # v3.1.0\n with:\n username: ${{ secrets.DOCKER_USERNAME }}\n password: ${{ secrets.DOCKER_PASSWORD }}\n\n - name: Build and push\n uses: docker/build-push-action@2cdde995de11925a030ce8070c3d77a52ffcf1c0 # v5.3.0\n with:\n context: .\n file: ./github-action/Dockerfile\n push: true\n tags: |\n asyncapi/github-action-for-cli:${{ steps.version.outputs.value }}\n asyncapi/github-action-for-cli:latest\n platforms: linux/amd64,linux/arm64\n\n - name: Change directory to github-action\n run: |\n cd github-action/\n ls -la\n\n - uses: meeDamian/sync-readme@82715041300710d9be7c726c9d6c683b70451087 # v1.0.6\n with:\n user: ${{ secrets.DOCKER_USERNAME }}\n pass: ${{ secrets.DOCKER_PASSWORD }}\n slug: asyncapi/github-action-for-cli\n description: Github action for AsyncAPI CLI\n\n" }, { "path": ".github/workflows/release-server-api.yml", "content": "name: Release Server API Image\non: \n release:\n types: \n - published\n workflow_dispatch:\n inputs:\n version:\n description: 'Version to release'\n required: true\njobs:\n\n publish-docker:\n name: Generating Docker\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n\n - name: Get version without v character\n id: version\n run: |\n VERSION=${{github.event.release.tag_name || github.event.inputs.version}}\n VERSION_WITHOUT_V=${VERSION:1}\n echo \"value=${VERSION_WITHOUT_V}\" >> $GITHUB_OUTPUT\n\n - name: Set Up QEMU\n uses: docker/setup-qemu-action@v3\n\n - name: Set Up Docker Buildx\n uses: docker/setup-buildx-action@v3\n\n - name: Login to Docker Hub\n uses: docker/login-action@v3\n with:\n username: ${{ secrets.DOCKER_USERNAME }}\n password: ${{ secrets.DOCKER_PASSWORD }}\n\n - name: Build and Push Docker Image\n uses: docker/build-push-action@v6\n id: push\n with:\n context: .\n file: ./src/apps/api/Dockerfile\n push: true\n tags: |\n asyncapi/server-api:${{ steps.version.outputs.value }}\n asyncapi/server-api:latest\n platforms: linux/amd64,linux/arm64\n \n - uses: meeDamian/sync-readme@82715041300710d9be7c726c9d6c683b70451087 #version 1.0.6 https://github.com/meeDamian/sync-readme/releases/tag/v1.0.6\n with:\n user: ${{secrets.DOCKER_USERNAME}}\n pass: ${{ secrets.DOCKER_PASSWORD }}\n slug: asyncapi/server-api\n readme: ./src/apps/api/README.md\n description: Server API providing official AsyncAPI tools\n\n outputs:\n digest: ${{ steps.push.outputs.digest }}\n\n deploy-app:\n name: Deploy to DigitalOcean App\n needs: publish-docker\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n \n - name: Deploy to DigitalOcean App\n uses: digitalocean/app_action/deploy@190f99be3ce4cbbe5d1ca0a63a8ac9d0add205d0\n env:\n DOCKER_DIGEST: ${{ needs.publish-docker.outputs.digest }}\n with:\n token: ${{ secrets.DIGITALOCEAN_ACCESS_TOKEN }}\n app_spec_location: ./src/apps/api/.do/app.yaml\n print_deploy_logs: true\n" }, { "path": ".github/workflows/release-with-changesets.yml", "content": "# It does magic only if there is a package.json file in the root of the project\nname: Release\n\non:\n push:\n branches:\n - master\n # The below lines are not enough to have release supported for these branches\n - next-spec\n - next-major\n - next-major-spec\n - beta\n - alpha\n - next\n\njobs:\n test-nodejs:\n # We just check the message of the first commit as there is always just one commit because we squash into one before merging\n # \"commits\" contains an array of objects where one of the properties is the commit \"message\"\n # Release workflow will be skipped if release conventional commits are not used\n if: |\n (startsWith( github.event.commits[0].message , 'fix:' ) ||\n startsWith( github.event.commits[0].message, 'fix!:' ) ||\n startsWith( github.event.commits[0].message, 'feat:' ) ||\n startsWith( github.event.commits[0].message, 'chore(release):' ) ||\n startsWith( github.event.commits[0].message, 'feat!:' ))\n name: Test NodeJS release on ${{ matrix.os }}\n runs-on: ${{ matrix.os }}\n strategy:\n matrix:\n os: [ubuntu-latest, macos-latest, windows-latest]\n steps:\n - name: Set git to use LF # To once and for all finish the never-ending fight between Unix and Windows\n run: |\n git config --global core.autocrlf false\n git config --global core.eol lf\n shell: bash\n - name: Checkout repository\n uses: actions/checkout@v4\n - name: Check if Node.js project and has package.json\n id: packagejson\n run: test -e ./package.json && echo \"exists=true\" >> $GITHUB_OUTPUT || echo \"exists=false\" >> $GITHUB_OUTPUT\n shell: bash\n - if: steps.packagejson.outputs.exists == 'true'\n name: Check package-lock version\n uses: asyncapi/.github/.github/actions/get-node-version-from-package-lock@master\n id: lockversion\n - if: steps.packagejson.outputs.exists == 'true'\n name: Setup Node.js\n uses: actions/setup-node@v4\n with:\n node-version: \"${{ steps.lockversion.outputs.version }}\"\n registry-url: \"https://registry.npmjs.org\"\n - if: steps.lockversion.outputs.version == '18' && matrix.os == 'windows-latest'\n name: Install npm cli 8\n shell: bash\n # npm cli 10 is buggy because of some cache issues\n run: npm install -g npm@8.19.4\n - if: steps.packagejson.outputs.exists == 'true'\n name: Install dependencies\n shell: bash\n run: npm ci\n - if: steps.packagejson.outputs.exists == 'true'\n name: Run test\n run: npm test --if-present\n - if: failure() # Only, on failure, send a message on the 94_bot-failing-ci slack channel\n name: Report workflow run status to Slack\n uses: 8398a7/action-slack@fbd6aa58ba854a740e11a35d0df80cb5d12101d8 # v3.15.1\n with:\n status: ${{ job.status }}\n fields: repo,action,workflow\n text: \"Release workflow failed in testing job\"\n env:\n SLACK_WEBHOOK_URL: ${{ secrets.SLACK_CI_FAIL_NOTIFY }}\n\n release:\n needs: [test-nodejs]\n name: Publish to any of NPM, GitHub, or Docker Hub\n runs-on: ubuntu-latest\n permissions:\n contents: write\n id-token: write\n pull-requests: write\n steps:\n - name: Set git to use LF # To once and for all finish the never-ending fight between Unix and Windows\n run: |\n git config --global core.autocrlf false\n git config --global core.eol lf\n - name: Checkout repository\n uses: actions/checkout@v6\n - name: Check if Node.js project and has package.json\n id: packagejson\n run: test -e ./package.json && echo \"exists=true\" >> $GITHUB_OUTPUT || echo \"exists=false\" >> $GITHUB_OUTPUT\n shell: bash\n - if: steps.packagejson.outputs.exists == 'true'\n name: Check package-lock version\n uses: asyncapi/.github/.github/actions/get-node-version-from-package-lock@master\n id: lockversion\n with:\n node-version: ${{ vars.NODE_VERSION }}\n - if: steps.packagejson.outputs.exists == 'true'\n name: Setup Node.js\n uses: actions/setup-node@v6\n with:\n node-version: \"${{ steps.lockversion.outputs.version }}\"\n - if: steps.packagejson.outputs.exists == 'true'\n name: Install dependencies\n shell: bash\n run: npm ci\n - if: steps.packagejson.outputs.exists == 'true'\n name: Install changelog\n shell: bash\n # This step can be removed once the issue is fixed in the changeset package.\n run: npm install @changesets/changelog-git@0.2.0\n\n - if: steps.packagejson.outputs.exists == 'true'\n name: Publish to any of NPM, Github, and Docker Hub\n #this step has 2 goals, it is either identifying that there is changeset file created and then this action creates a PR with version bump that will trigger release - or if it sees there is no changeset, and there are versions changes in package.json files, it publish new versions to NPM is they are not there yet\n # However, as currently changeset's publish isn't working well with OIDC next step will directly publish to NPM if there are version changes but no changesets\n uses: changesets/action@e0145edc7d9d8679003495b11f87bd8ef63c0cba # v1.5.3\n id: release\n with:\n version: npm run bump:version\n commit: \"chore(release): release and bump versions of packages\"\n title: \"chore(release): release and bump versions of packages\"\n # Working around changesets action not supporting OIDC yet. Need to pass successful release output for triggering github release\n publish: npm run publish:trusted\n setupGitUser: false\n env:\n GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}\n GIT_AUTHOR_NAME: asyncapi-bot\n GIT_AUTHOR_EMAIL: info@asyncapi.io\n GIT_COMMITTER_NAME: asyncapi-bot\n GIT_COMMITTER_EMAIL: info@asyncapi.io\n\n - name: Publish to NPM directly (skip if version already published)\n if: steps.packagejson.outputs.exists == 'true' && steps.release.outputs.hasChangesets == 'false'\n shell: bash\n run: |\n # Check if the version in package.json is already published\n VERSION=$(node -p \"require('./package.json').version\")\n PACKAGE_NAME=$(node -p \"require('./package.json').name\")\n if npm view \"$PACKAGE_NAME@$VERSION\" > /dev/null 2>&1; then\n echo \"Version $VERSION of package $PACKAGE_NAME is already published. Skipping publish.\"\n else\n echo \"Publishing version $VERSION of package $PACKAGE_NAME to NPM.\"\n npm publish --provenance\n fi\n\n - if: failure() # Only, on failure, send a message on the 94_bot-failing-ci Slack channel\n name: Report workflow run status to Slack\n uses: 8398a7/action-slack@fbd6aa58ba854a740e11a35d0df80cb5d12101d8 # v3.15.1\n with:\n status: ${{ job.status }}\n fields: repo,action,workflow\n text: \"Release workflow failed in release job\"\n env:\n SLACK_WEBHOOK_URL: ${{ secrets.SLACK_CI_FAIL_NOTIFY }}\n" }, { "path": ".github/workflows/scripts/README.md", "content": "The entire `scripts` directory is centrally managed in [.github](https://github.com/asyncapi/.github/) repository. Any changes in this folder should be done in central repository." }, { "path": ".github/workflows/scripts/kit/htmlContent.js", "content": "/**\n * This code is centrally managed in https://github.com/asyncapi/.github/\n * 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\n *\n * Kit.com version — greeting uses Kit Liquid (subscriber.first_name). Unsubscribe is provided by the Kit email template/footer.\n */\n\n/**\n * Escape HTML special characters to prevent XSS\n */\nfunction escapeHtml(text) {\n if (!text) return '';\n return text\n .replace(/&/g, '&')\n .replace(//g, '>')\n .replace(/\"/g, '"')\n .replace(/'/g, ''');\n}\n\nmodule.exports = (link, title) => {\n // Sanitize inputs to prevent XSS\n const safeLink = escapeHtml(link);\n const safeTitle = escapeHtml(title);\n\n return `\n\n \n \n \n \n \n \n ${safeTitle}\n \n \n \n
\n \n \n \n \n
\n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n \n \n \n \n
\n \t\n\t\t\t \n\t\t\t\t\n \n \n \n \n \n
\n \n Hey {{ subscriber.first_name | strip | default: \"TSC member\" }},
\n
\nThere is a new topic at AsyncAPI Initiative that requires Technical Steering Committee attention. \n
\nPlease have a look if it is just something you need to be aware of, or maybe your vote is needed.\n
\nTopic: ${ safeTitle }.\n
\n\t\t\t\t\n \n\t\t\t\t\n
\n \n\n \n \n \n \n \n
\n \t\n\t\t\t \n\t\t\t\t\n \n \n \n \n \n
\n \n Cheers,
\nAsyncAPI Initiative\n
\n\t\t\t\t\n \n\t\t\t\t\n
\n \n \n \n \n \n
\n \t\n\t\t\t \n\t\t\t\t\n \n \n \n \n \n
\n \n You are receiving this email because you are subscribed to TSC Voting notifications.
\n \n
\n\t\t\t\t\n \n\t\t\t\t\n
\n \n \n
\n
\n \n\n`\n}" }, { "path": ".github/workflows/scripts/kit/index.js", "content": "/**\n * This code is centrally managed in https://github.com/asyncapi/.github/\n * 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\n */\nconst core = require('@actions/core');\nconst htmlContent = require('./htmlContent.js');\n\nconst sanitizeLinkAndTitle = (link, title) => {\n // Validate inputs to prevent injection attacks\n if (!link || typeof link !== 'string' || link.length > 2000) {\n return core.setFailed('Invalid link parameter');\n }\n if (!title || typeof title !== 'string' || title.length > 500) {\n return core.setFailed('Invalid title parameter');\n }\n\n let parsedLink;\n try {\n parsedLink = new URL(link);\n } catch (error) {\n return core.setFailed('Invalid link parameter');\n }\n\n if (parsedLink.protocol !== 'https:') {\n return core.setFailed('Link must use https protocol');\n }\n\n // Sanitize title by removing control characters and limiting length\n const sanitizedTitle = title.replace(/[\\x00-\\x1F\\x7F]/g, '').substring(0, 250);\n return { sanitizedLink: parsedLink.toString(), sanitizedTitle };\n};\n\nmodule.exports = async (link, title) => {\n const KIT_BASE = 'https://api.kit.com/v4';\n const TSC_TAG_ID = Number(process.env.KIT_TSC_TAG_ID);\n\n // Schedule 1 minute ahead\n const sendAt = new Date(Date.now() + 60 * 1000);\n\n const { sanitizedLink, sanitizedTitle } = sanitizeLinkAndTitle(link, title);\n\n const res = await fetch(`${KIT_BASE}/broadcasts`, {\n method: 'POST',\n headers: {\n 'X-Kit-Api-Key': process.env.KIT_API_KEY,\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({\n subject: `TSC attention required: ${sanitizedTitle}`,\n preview_text: 'Check out the latest topic that TSC members have to be aware of',\n content: htmlContent(sanitizedLink, sanitizedTitle),\n description: `TSC notification - ${new Date().toUTCString()}`,\n public: false,\n published_at: null,\n send_at: sendAt.toISOString(),\n subscriber_filter: [{ all: [{ type: 'tag', ids: [TSC_TAG_ID] }] }]\n })\n });\n\n if (!res.ok) return core.setFailed(`Failed creating broadcast: ${await res.text()}`);\n core.info(`Kit.com TSC broadcast scheduled for ${sendAt.toISOString()}`);\n};\n" }, { "path": ".github/workflows/scripts/kit/package.json", "content": "{\n \"name\": \"schedule-email\",\n \"description\": \"Kit.com email broadcast script for TSC notifications. This file is centrally managed in https://github.com/asyncapi/.github/\",\n \"license\": \"Apache 2.0\",\n \"dependencies\": {\n \"@actions/core\": \"1.6.0\"\n }\n}\n" }, { "path": ".github/workflows/scripts/mailchimp/htmlContent.js", "content": "/**\n * This code is centrally managed in https://github.com/asyncapi/.github/\n * 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\n */\n\n/**\n * Escape HTML special characters to prevent XSS\n */\nfunction escapeHtml(text) {\n if (!text) return '';\n return text\n .replace(/&/g, '&')\n .replace(//g, '>')\n .replace(/\"/g, '"')\n .replace(/'/g, ''');\n}\n\nmodule.exports = (link, title) => {\n // Sanitize inputs to prevent XSS\n const safeLink = escapeHtml(link);\n const safeTitle = escapeHtml(title);\n\n return `\n\n \n \n \n \n \n \n *|MC:SUBJECT|*\n \n \n \n \n *|MC_PREVIEW_TEXT|*\n \n
\n \n \n \n \n
\n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n \n \n \n \n
\n \t\n\t\t\t \n\t\t\t\t\n \n \n \n \n \n
\n \n Hey *|FNAME|*,
\n
\nThere is a new topic at AsyncAPI Initiative that requires Technical Steering Committee attention. \n
\nPlease have a look if it is just something you need to be aware of, or maybe your vote is needed.\n
\nTopic: ${ safeTitle }.\n
\n\t\t\t\t\n \n\t\t\t\t\n
\n \n\n \n \n \n \n \n
\n \t\n\t\t\t \n\t\t\t\t\n \n \n \n \n \n
\n \n Cheers,
\nAsyncAPI Initiative\n
\n\t\t\t\t\n \n\t\t\t\t\n
\n \n \n \n \n \n
\n \t\n\t\t\t \n\t\t\t\t\n \n \n \n \n \n
\n \n Want to change how you receive these emails?
\nYou can update your preferences or unsubscribe from this list.
\n \n
\n\t\t\t\t\n \n\t\t\t\t\n
\n \n \n
\n
\n \n\n`\n}" }, { "path": ".github/workflows/stale-issues-prs.yml", "content": "# This action is centrally managed in https://github.com/asyncapi/.github/\n# 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\n\nname: Manage stale issues and PRs\n\non:\n schedule:\n - cron: \"0 0 * * *\"\n\npermissions: {}\n\njobs:\n stale:\n if: startsWith(github.repository, 'asyncapi/')\n name: Mark issue or PR as stale\n runs-on: ubuntu-latest\n permissions:\n contents: read # As delete-branch is not being used\n issues: write # To add comments and labels to issues\n pull-requests: write # To add comments and labels to PRs\n steps:\n - uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 #v9.1.0 but pointing to commit for security reasons\n with:\n repo-token: ${{ github.token }}\n stale-issue-message: |\n This issue has been automatically marked as stale because it has not had recent activity :sleeping:\n\n It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation. \n\n There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under [open governance model](https://github.com/asyncapi/community/blob/master/CHARTER.md). \n\n Let us figure out together how to push this issue forward. Connect with us through [one of many communication channels](https://github.com/asyncapi/community/issues/1) we established here.\n\n Thank you for your patience :heart:\n stale-pr-message: |\n This pull request has been automatically marked as stale because it has not had recent activity :sleeping:\n\n It will be closed in 120 days if no further activity occurs. To unstale this pull request, add a comment with detailed explanation.\n\n There can be many reasons why some specific pull request has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under [open governance model](https://github.com/asyncapi/community/blob/master/CHARTER.md). \n\n Let us figure out together how to push this pull request forward. Connect with us through [one of many communication channels](https://github.com/asyncapi/community/issues/1) we established here.\n\n Thank you for your patience :heart:\n days-before-stale: 120\n days-before-close: 120\n stale-issue-label: stale\n stale-pr-label: stale\n exempt-issue-labels: keep-open\n exempt-pr-labels: keep-open\n close-issue-reason: not_planned\n" }, { "path": ".github/workflows/test-action.yml", "content": "name: PR testing of CLI action\n\non:\n pull_request:\n types: [ opened, synchronize, reopened, ready_for_review ]\n\njobs:\n should-workflow-run:\n runs-on: ubuntu-latest\n steps:\n - if: >\n !github.event.pull_request.draft && !(\n (github.actor == 'asyncapi-bot' && (\n startsWith(github.event.pull_request.title, 'ci: update of files from global .github repo') ||\n startsWith(github.event.pull_request.title, 'chore(release):')\n )) ||\n (github.actor == 'asyncapi-bot-eve' && (\n startsWith(github.event.pull_request.title, 'ci: update of files from global .github repo') ||\n startsWith(github.event.pull_request.title, 'chore(release):')\n )) ||\n (github.actor == 'allcontributors[bot]' &&\n startsWith(github.event.pull_request.title, 'docs: add')\n )\n )\n id: should_run\n name: Should Run\n run: echo \"shouldrun=true\" >> $GITHUB_OUTPUT\n outputs:\n shouldrun: ${{ steps.should_run.outputs.shouldrun }}\n\n build-docker:\n needs: should-workflow-run\n name: Build Docker image\n if: ${{ needs.should-workflow-run.outputs.shouldrun == 'true' }}\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - name: Get docker version\n id: docker_version\n run: >\n ls -la;\n action=$(cat action.yml);\n regex='docker:\\/\\/asyncapi\\/github-action-for-cli:([0-9.]+)';\n [[ $action =~ $regex ]];\n action_version=${BASH_REMATCH[1]};\n echo \"action_version=$action_version\" >> $GITHUB_OUTPUT\n - name: Set up Docker Buildx\n uses: docker/setup-buildx-action@v3\n - name: Build Docker image and export\n uses: docker/build-push-action@v5\n with:\n context: .\n file: ./github-action/Dockerfile\n tags: asyncapi/github-action-for-cli:${{ steps.docker_version.outputs.action_version }}\n outputs: type=docker,dest=/tmp/asyncapi.tar\n - name: Upload artifact\n uses: actions/upload-artifact@v4\n with:\n name: asyncapi\n path: /tmp/asyncapi.tar\n\n\n test-defaults:\n if: ${{ needs.should-workflow-run.outputs.shouldrun == 'true' }}\n runs-on: ubuntu-latest\n needs: [should-workflow-run, build-docker]\n steps:\n - name: Download artifact\n uses: actions/download-artifact@v4\n with:\n name: asyncapi\n path: /tmp\n - name: Load Docker image\n run: |\n docker load --input /tmp/asyncapi.tar\n docker image ls -a\n - uses: actions/checkout@v4\n - name: Remove bin directory to disable developer mode\n run: rm -rf ./bin\n - name: Test GitHub Action\n uses: ./\n with:\n filepath: ./github-action/test/asyncapi.yml\n - name: Assert GitHub Action\n run: |\n echo \"Listing all files\"\n ls -R\n echo \"Asserting GitHub Action\"\n if [ -f \"./output/asyncapi.md\" ]; then\n echo \"Files exist\"\n else\n echo \"Files do not exist:- ./output/asyncapi.md\"\n echo \"Action failed\"\n exit 1\n fi\n\n test-validate-success:\n if: ${{ needs.should-workflow-run.outputs.shouldrun == 'true' }}\n runs-on: ubuntu-latest\n needs: [should-workflow-run, build-docker]\n steps:\n - name: Download artifact\n uses: actions/download-artifact@v4\n with:\n name: asyncapi\n path: /tmp\n - name: Load Docker image\n run: |\n docker load --input /tmp/asyncapi.tar\n docker image ls -a\n - uses: actions/checkout@v4\n - name: Remove bin directory to disable developer mode\n run: rm -rf ./bin\n - name: Test GitHub Action\n uses: ./\n with:\n filepath: ./github-action/test/asyncapi.yml\n command: validate\n\n test-custom-command:\n if: ${{ needs.should-workflow-run.outputs.shouldrun == 'true' }}\n runs-on: ubuntu-latest\n needs: [should-workflow-run, build-docker]\n steps:\n - name: Download artifact\n uses: actions/download-artifact@v4\n with:\n name: asyncapi\n path: /tmp\n - name: Load Docker image\n run: |\n docker load --input /tmp/asyncapi.tar\n docker image ls -a\n - uses: actions/checkout@v4\n - name: Remove bin directory to disable developer mode\n run: rm -rf ./bin\n - name: Test GitHub Action\n uses: ./\n with:\n # Custom command to generate models\n # Note: You can use command itself to generate models, but this is just an example for testing custom commands\n custom_command: \"generate models typescript ./github-action/test/asyncapi.yml -o ./output\"\n - name: Assert GitHub Action\n run: |\n echo \"Listing all files\"\n ls -R\n echo \"Asserting GitHub Action\"\n if [ -f \"./output/AnonymousSchema_1.ts\" ]; then\n echo \"Models have been generated\"\n else\n echo \"Models have not been generated\"\n echo \"Action failed\"\n exit 1\n fi\n\n test-custom-output:\n if: ${{ needs.should-workflow-run.outputs.shouldrun == 'true' }}\n runs-on: ubuntu-latest\n needs: [should-workflow-run, build-docker]\n steps:\n - name: Download artifact\n uses: actions/download-artifact@v4\n with:\n name: asyncapi\n path: /tmp\n - name: Load Docker image\n run: |\n docker load --input /tmp/asyncapi.tar\n docker image ls -a\n - uses: actions/checkout@v4\n - name: Remove bin directory to disable developer mode\n run: rm -rf ./bin\n - name: Test GitHub Action\n uses: ./\n with:\n filepath: ./github-action/test/asyncapi.yml\n output: custom-output\n - name: Assert GitHub Action\n run: |\n echo \"Listing all files\"\n ls -R\n echo \"Asserting GitHub Action\"\n if [ -f \"./custom-output/asyncapi.md\" ]; then\n echo \"Files exist\"\n else\n echo \"Files do not exist:- ./custom-output/asyncapi.md\"\n echo \"Action failed\"\n exit 1\n fi\n\n test-file-not-found:\n if: ${{ needs.should-workflow-run.outputs.shouldrun == 'true' }}\n runs-on: ubuntu-latest\n needs: [should-workflow-run, build-docker]\n steps:\n - name: Download artifact\n uses: actions/download-artifact@v4\n with:\n name: asyncapi\n path: /tmp\n - name: Load Docker image\n run: |\n docker load --input /tmp/asyncapi.tar\n docker image ls -a\n - uses: actions/checkout@v4\n - name: Remove bin directory to disable developer mode\n run: rm -rf ./bin\n - name: Test GitHub Action\n id: test\n uses: ./\n with:\n filepath: non_existent_file.yml\n continue-on-error: true\n - name: Check for failure\n run: |\n if [ \"${{ steps.test.outcome }}\" == \"success\" ]; then\n echo \"Test Failure: non_existent_file.yml should throw an error but did not\"\n exit 1\n else\n echo \"Test Success: non_existent_file.yml threw an error as expected\"\n fi\n\n test-invalid-input:\n if: ${{ needs.should-workflow-run.outputs.shouldrun == 'true' }}\n runs-on: ubuntu-latest\n needs: [should-workflow-run, build-docker]\n steps:\n - name: Download artifact\n uses: actions/download-artifact@v4\n with:\n name: asyncapi\n path: /tmp\n - name: Load Docker image\n run: |\n docker load --input /tmp/asyncapi.tar\n docker image ls -a\n - uses: actions/checkout@v4\n - name: Remove bin directory to disable developer mode\n run: rm -rf ./bin\n - name: Test GitHub Action\n id: test\n uses: ./\n with:\n filepath: github-action/test/asyncapi.yml\n command: generate # No template or language specified\n template: '' # Empty string\n continue-on-error: true\n - name: Check for failure\n run: |\n if [ \"${{ steps.test.outcome }}\" == \"success\" ]; then\n echo \"Test Failure: generate command should throw an error as no template or language specified but did not\"\n exit 1\n else\n echo \"Test Success: generate command threw an error as expected\"\n fi\n\n test-optimize:\n if: ${{ needs.should-workflow-run.outputs.shouldrun == 'true' }}\n runs-on: ubuntu-latest\n needs: [should-workflow-run, build-docker]\n steps:\n - name: Download artifact\n uses: actions/download-artifact@v4\n with:\n name: asyncapi\n path: /tmp\n - name: Load Docker image\n run: |\n docker load --input /tmp/asyncapi.tar\n docker image ls -a\n - uses: actions/checkout@v4\n - name: Remove bin directory to disable developer mode\n run: rm -rf ./bin\n - name: Test GitHub Action\n uses: ./\n with:\n filepath: github-action/test/unoptimized.yml\n command: optimize\n parameters: '-o new-file --no-tty'\n - name: Assert GitHub Action\n run: |\n echo \"Listing all files\"\n ls -R\n echo \"Asserting GitHub Action\"\n if [ -f \"./github-action/test/unoptimized_optimized.yml\" ]; then\n echo \"The specified file has been optimized\"\n else\n echo \"The specified file has not been optimized\"\n echo \"Action failed\"\n exit 1\n fi\n\n test-bundle:\n if: ${{ needs.should-workflow-run.outputs.shouldrun == 'true' }}\n runs-on: ubuntu-latest\n needs: [should-workflow-run, build-docker]\n steps:\n - name: Download artifact\n uses: actions/download-artifact@v4\n with:\n name: asyncapi\n path: /tmp\n - name: Load Docker image\n run: |\n docker load --input /tmp/asyncapi.tar\n docker image ls -a\n - uses: actions/checkout@v4\n - name: Remove bin directory to disable developer mode\n run: rm -rf ./bin\n - name: Make output directory\n run: mkdir -p ./output/bundle\n - name: Test GitHub Action\n uses: ./\n with:\n custom_command: 'bundle ./github-action/test/bundle/asyncapi.yaml ./github-action/test/bundle/features.yaml --base ./github-action/test/bundle/asyncapi.yaml -o ./output/bundle/asyncapi.yaml'\n - name: Assert GitHub Action\n run: |\n echo \"Listing all files\"\n ls -R\n echo \"Asserting GitHub Action\"\n if [ -f \"./output/bundle/asyncapi.yaml\" ]; then\n echo \"The specified files have been bundled\"\n else\n echo \"The specified files have not been bundled\"\n echo \"Action failed\"\n exit 1\n fi\n\n test-convert:\n if: ${{ needs.should-workflow-run.outputs.shouldrun == 'true' }}\n runs-on: ubuntu-latest\n needs: [should-workflow-run, build-docker]\n steps:\n - name: Download artifact\n uses: actions/download-artifact@v4\n with:\n name: asyncapi\n path: /tmp\n - name: Load Docker image\n run: |\n docker load --input /tmp/asyncapi.tar\n docker image ls -a\n - uses: actions/checkout@v4\n - name: Remove bin directory to disable developer mode\n run: rm -rf ./bin\n - name: Test GitHub Action\n uses: ./\n with:\n command: convert\n filepath: github-action/test/asyncapi.yml\n output: output/convert/asyncapi.yaml\n - name: Assert GitHub Action\n run: |\n echo \"Listing all files\"\n ls -R\n echo \"Asserting GitHub Action\"\n if [ -f \"./output/convert/asyncapi.yaml\" ]; then\n echo \"The specified file has been converted\"\n else\n echo \"The specified file has not been converted\"\n echo \"Action failed\"\n exit 1\n fi\n" }, { "path": ".github/workflows/update-docs-in-website.yml", "content": "name: Update latest CLI documentation in the website\n\non:\n push:\n branches:\n - 'master'\n paths:\n - 'docs/*.md'\n workflow_dispatch:\njobs:\n Make-PR:\n name: Make PR on website repository with updated latest CLI documentation\n runs-on: ubuntu-latest\n env:\n GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}\n steps:\n - name: Checkout Current repository\n uses: actions/checkout@v3\n with:\n path: cli\n - name: Checkout Another repository\n uses: actions/checkout@v3\n with:\n repository: asyncapi/website\n path: website\n token: ${{ env.GITHUB_TOKEN }}\n - name: Config git\n run: |\n git config --global user.name asyncapi-bot\n git config --global user.email info@asyncapi.io\n - name: Create branch\n working-directory: ./website\n run: |\n git checkout -b update-cli-docs-${{ github.sha }}\n - name: Copy cli folder from Current Repo to Another\n working-directory: ./website\n run: |\n mkdir -p ./markdown/docs/tools/cli\n printf \"%s\\ntitle: CLI\\nweight: 10\\n%s\" \"---\" \"---\"> ../cli/docs/_section.md\n mv ../cli/docs/*.md ./markdown/docs/tools/cli\n - name: Commit and push\n working-directory: ./website\n run: |\n git add .\n git commit -m \"docs(cli): update latest cli docs\"\n git push https://${{ env.GITHUB_TOKEN }}@github.com/asyncapi/website\n - name: Create PR\n working-directory: ./website\n run: |\n gh pr create --title \"docs(cli): update latest cli documentation\" --body \"Updated cli documentation is available and this PR introduces update to cli folder on the website\" --head \"update-cli-docs-${{ github.sha }}\"\n" }, { "path": ".github/workflows/update-docs-on-docs-commits.yml", "content": "# This workflow is centrally managed in https://github.com/asyncapi/.github/\n# 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\n\n# The given workflow is responsible for generating docs and creating PR with them when there is a commit with docs: prefix\n\n# This workflow will be updated in all repos with the topic get-global-docs-autoupdate\n\nname: 'Update generated parts of documentation on docs: commits'\n\non:\n push:\n branches:\n - master\n\njobs:\n docs-gen:\n name: 'Generate docs and create PR'\n runs-on: ubuntu-latest\n # PR should be created within this GH action only if it is a docs: commit\n # Otherwise it will conflict with release workflow\n if: startsWith(github.event.commits[0].message, 'docs:')\n steps:\n - name: Checkout repo\n uses: actions/checkout@v4\n - name: Determine what node version to use\n # This workflow is from our own org repo and safe to reference by 'master'.\n uses: asyncapi/.github/.github/actions/get-node-version-from-package-lock@master # //NOSONAR\n with:\n node-version: ${{ vars.NODE_VERSION }}\n id: lockversion\n - name: Use Node.js\n uses: actions/setup-node@v4\n with:\n node-version: \"${{ steps.lockversion.outputs.version }}\"\n cache: 'npm'\n cache-dependency-path: '**/package-lock.json'\n - name: Install dependencies\n run: npm ci\n - name: Regenerate docs\n run: npm run generate:assets --if-present\n - name: Create Pull Request with updated docs\n uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # uses 7.0.8 https://github.com/peter-evans/create-pull-request/releases/tag/v7.0.8\n with:\n token: ${{ secrets.GH_TOKEN }}\n commit-message: 'chore: update generated docs'\n committer: asyncapi-bot \n author: asyncapi-bot \n title: 'chore: update generated docs'\n body: 'Update of docs that are generated and were forgotten on PR level.'\n branch: gen-docs-update/${{ github.job }}\n - name: Report workflow status to Slack\n if: failure() # Only, on failure, send a message on the 94_bot-failing-ci slack channel\n uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 #using https://github.com/8398a7/action-slack/releases/tag/v3.16.2\n with:\n status: ${{ job.status }}\n fields: repo,action,workflow\n text: 'AsyncAPI docs generation workflow failed'\n author_name: asyncapi-bot\n env:\n SLACK_WEBHOOK_URL: ${{ secrets.SLACK_CI_FAIL_NOTIFY }} " }, { "path": ".github/workflows/update-maintainers-trigger.yaml", "content": "# This action is centrally managed in https://github.com/asyncapi/.github/\n# 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\n\nname: Trigger MAINTAINERS.yaml file update\n\non:\n push:\n branches: [ master ]\n paths:\n # Check all valid CODEOWNERS locations: \n # https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners#codeowners-file-location\n - 'CODEOWNERS'\n - '.github/CODEOWNERS'\n - '.docs/CODEOWNERS'\n\npermissions: \n contents: read # Just to limit GITHUB_TOKEN as we use GH_TOKEN only\n\njobs:\n trigger-maintainers-update:\n name: Trigger updating MAINTAINERS.yaml because of CODEOWNERS change\n runs-on: ubuntu-latest\n \n steps:\n - name: Repository Dispatch\n uses: peter-evans/repository-dispatch@ff45666b9427631e3450c54a1bcbee4d9ff4d7c0 # https://github.com/peter-evans/repository-dispatch/releases/tag/v3.0.0\n with:\n # The PAT with the 'public_repo' scope is required\n token: ${{ secrets.GH_TOKEN }}\n repository: ${{ github.repository_owner }}/community\n event-type: trigger-maintainers-update\n" }, { "path": ".github/workflows/update-pr.yml", "content": "# This workflow is centrally managed in https://github.com/asyncapi/.github/\n# 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\n\n# This workflow will run on every comment with /update or /u. And will create merge-commits for the PR.\n# This also works with forks, not only with branches in the same repository/organization.\n# Currently, does not work with forks in different organizations.\n\n# This workflow will be distributed to all repositories in the AsyncAPI organization\n\nname: Update PR branches from fork\n\npermissions:\n contents: read\n\non:\n issue_comment: \n types: [created]\n\njobs:\n update-pr:\n name: Update the fork PR with upstream changes\n if: >\n startsWith(github.repository, 'asyncapi/') &&\n github.event.issue.pull_request && \n github.event.issue.state != 'closed' && (\n contains(github.event.comment.body, '/update') ||\n contains(github.event.comment.body, '/u')\n )\n runs-on: ubuntu-latest\n permissions:\n issues: write # Required to read PR details and post comments on the PR\n pull-requests: write # Required to update the PR branch \n contents: read\n steps:\n - name: Get Pull Request Details\n id: pr\n uses: actions/github-script@v7\n with:\n github-token: ${{ secrets.GH_TOKEN || github.token }}\n previews: 'merge-info-preview' # https://docs.github.com/en/graphql/overview/schema-previews#merge-info-preview-more-detailed-information-about-a-pull-requests-merge-state-preview\n script: |\n const prNumber = context.payload.issue.number;\n core.debug(`PR Number: ${prNumber}`);\n const { data: pr } = await github.rest.pulls.get({\n owner: context.repo.owner,\n repo: context.repo.repo,\n pull_number: prNumber\n });\n\n // If the PR has conflicts, we don't want to update it\n const updateable = ['behind', 'blocked', 'unknown', 'draft', 'clean', 'unstable'].includes(pr.mergeable_state);\n console.log(`PR #${prNumber} is ${pr.mergeable_state} and is ${updateable ? 'updateable' : 'not updateable'}`);\n core.setOutput('updateable', updateable);\n\n core.debug(`Updating PR #${prNumber} with head ${pr.head.sha}`);\n\n return {\n id: pr.node_id,\n number: prNumber,\n head: pr.head.sha,\n }\n - name: Update the Pull Request\n if: steps.pr.outputs.updateable == 'true'\n uses: actions/github-script@v7\n env:\n PR_DETAILS: ${{ steps.pr.outputs.result }}\n with:\n github-token: ${{ secrets.GH_TOKEN || github.token }}\n script: |\n const mutation = `mutation update($input: UpdatePullRequestBranchInput!) {\n updatePullRequestBranch(input: $input) {\n pullRequest {\n mergeable\n }\n }\n }`;\n\n const pr_details = JSON.parse(process.env.PR_DETAILS);\n\n try {\n const { data } = await github.graphql(mutation, {\n input: {\n pullRequestId: pr_details.id,\n expectedHeadOid: pr_details.head,\n }\n });\n } catch (GraphQLError) {\n core.debug(GraphQLError);\n if (\n GraphQLError.name === 'GraphqlResponseError' &&\n GraphQLError.errors.some(\n error => error.type === 'FORBIDDEN' || error.type === 'UNAUTHORIZED'\n )\n ) {\n // Add comment to PR if the bot doesn't have permissions to update the PR\n const comment = `Hi @${context.actor}. Update of PR has failed. It can be due to one of the following reasons:\n - I don't have permissions to update this PR. To update your fork with upstream using bot you need to enable [Allow edits from maintainers](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork) option in the PR. \n - The fork is located in an organization, not under your personal profile. No solution for that. You are on your own with manual update.\n - There may be a conflict in the PR. Please resolve the conflict and try again.`;\n\n await github.rest.issues.createComment({\n owner: context.repo.owner,\n repo: context.repo.repo,\n issue_number: context.issue.number,\n body: comment\n });\n\n core.setFailed('Bot does not have permissions to update the PR');\n } else {\n core.setFailed(GraphQLError.message);\n }\n }\n" }, { "path": ".github/workflows/upload-release-assets.yml", "content": "name: Upload custom assets to GitHub release\n\non:\n release:\n types:\n - published\n\nenv:\n CI: true\n\njobs:\n upload-assets:\n name: Generate and upload assets\n runs-on: ${{ matrix.os }}\n continue-on-error: true\n strategy:\n matrix:\n include:\n - os: ubuntu-latest\n npm_script: pack:linux\n dist_folder: deb\n extension: deb\n - os: ubuntu-latest\n npm_script: pack:tarballs\n dist_folder: tar\n extension: tar.gz\n - os: ubuntu-latest\n npm_script: pack:tarballs:alpine\n dist_folder: tar\n extension: alpine.tar.gz\n container: 'node:20-alpine'\n alpine: true\n - os: ubuntu-latest\n npm_script: pack:windows\n dist_folder: win32\n extension: x64.exe\n - os: ubuntu-latest\n npm_script: pack:windows\n dist_folder: win32\n extension: x86.exe\n - os: macos-latest\n npm_script: pack:macos\n dist_folder: macos\n extension: arm64.pkg\n - os: macos-latest\n npm_script: pack:macos\n dist_folder: macos\n extension: x64.pkg\n \n container: ${{ matrix.container }}\n \n steps:\n - name: Install base tools for alpine container\n if: matrix.container == 'node:20-alpine'\n run: |\n apk add --no-cache bash git python3 make g++ perl-utils xz\n\n - name: Checkout repository\n uses: actions/checkout@v4\n\n # Needed to avoid \"fatal: detected dubious ownership in repository\" error when using alpine container\n - name: Mark GitHub workspace as safe\n if: matrix.container == 'node:20-alpine'\n run: |\n git config --global --add safe.directory \"$GITHUB_WORKSPACE\"\n\n \n - name: Check package-lock version\n if: matrix.container == ''\n uses: asyncapi/.github/.github/actions/get-node-version-from-package-lock@master\n id: lockversion\n with:\n node-version: ${{ vars.NODE_VERSION }}\n \n - name: Setup Node.js\n if: matrix.container == ''\n uses: actions/setup-node@v6\n with:\n node-version: \"${{ steps.lockversion.outputs.version }}\"\n\n - name: Get version from package.json\n uses: actions/github-script@v6\n id: extractver\n with:\n script: |\n const packageJson = require('./package.json');\n const packageJsonVersion = packageJson.version;\n core.setOutput('version', packageJsonVersion);\n - if: matrix.npm_script == 'pack:windows'\n #fix for windows build issue #1433\n name: Install p7zip-full nsis\n run: sudo apt-get install -y p7zip-full nsis\n\n - if: matrix.npm_script == 'pack:windows'\n #npm cli 10 is buggy because of some cache issue\n name: Install npm cli 10\n shell: bash\n run: npm install -g npm@latest\n - name: Install dependencies\n run: npm ci\n - name: Build project\n shell: bash\n run: npm run prepublishOnly\n - name: Assets generation\n shell: bash\n run: |\n npm run ${{ matrix.npm_script }}\n if [[ \"${{ matrix.alpine }}\" == \"true\" ]]; then\n npm run pack:rename alpine\n else\n npm run pack:rename\n fi\n \n - name: Update release\n uses: softprops/action-gh-release@v1\n with:\n files: dist/${{ matrix.dist_folder }}/asyncapi.${{ matrix.extension }}\n tag_name: v${{ steps.extractver.outputs.version }}\n token: ${{ secrets.GH_TOKEN }}\n - if: failure() # Only, on failure, send a message on the 94_bot-failing-ci slack channel\n name: Report workflow run status to Slack\n uses: 8398a7/action-slack@fbd6aa58ba854a740e11a35d0df80cb5d12101d8 #using https://github.com/8398a7/action-slack/releases/tag/v3.15.1\n with:\n status: ${{ job.status }}\n fields: repo,action,workflow\n text: 'AsyncAPI CLI release build artifacts failed'\n env:\n SLACK_WEBHOOK_URL: ${{ secrets.SLACK_CI_FAIL_NOTIFY }}" }, { "path": ".github/workflows/welcome-first-time-contrib.yml", "content": "# This action is centrally managed in https://github.com/asyncapi/.github/\n# 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\n\nname: Welcome first time contributors\n\non:\n pull_request:\n types: \n - opened\n issues:\n types:\n - opened\n\npermissions:\n issues: read # Required to check if the issue is the user's first contribution\n pull-requests: read # Required to check if the pull request is the user's first contribution\n\njobs:\n welcome:\n name: Post welcome message\n if: ${{ !contains(fromJson('[\"asyncapi-bot\", \"dependabot[bot]\", \"dependabot-preview[bot]\", \"allcontributors[bot]\"]'), github.actor) }} # zizmor: ignore[obfuscation]\n runs-on: ubuntu-latest\n permissions:\n contents: read # Required to read repository data for checking if it's the user's first contribution\n issues: write # Required to post welcome message on issues\n pull-requests: write # Required to post welcome message on pull requests\n steps:\n - uses: actions/github-script@v7\n with:\n github-token: ${{ github.token }}\n script: |\n const issueMessage = `Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our [contributors guide](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md) and the instructions about a [basic recommended setup](https://github.com/asyncapi/community/blob/master/git-workflow.md) useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out [this issue](https://github.com/asyncapi/asyncapi/issues/115).`;\n const prMessage = `Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our [contributors guide](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md) useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out [this issue](https://github.com/asyncapi/asyncapi/issues/115).`;\n if (!issueMessage && !prMessage) {\n throw new Error('Action must have at least one of issue-message or pr-message set');\n }\n const isIssue = !!context.payload.issue;\n let isFirstContribution;\n if (isIssue) {\n const query = `query($owner:String!, $name:String!, $contributer:String!) {\n repository(owner:$owner, name:$name){\n issues(first: 1, filterBy: {createdBy:$contributer}){\n totalCount\n }\n }\n }`;\n const variables = {\n owner: context.repo.owner,\n name: context.repo.repo,\n contributer: context.payload.sender.login\n };\n const { repository: { issues: { totalCount } } } = await github.graphql(query, variables);\n isFirstContribution = totalCount === 1;\n } else {\n const query = `query($qstr: String!) {\n search(query: $qstr, type: ISSUE, first: 1) {\n issueCount\n }\n }`;\n const variables = {\n \"qstr\": `repo:${context.repo.owner}/${context.repo.repo} type:pr author:${context.payload.sender.login}`,\n };\n const { search: { issueCount } } = await github.graphql(query, variables);\n isFirstContribution = issueCount === 1;\n }\n \n if (!isFirstContribution) {\n console.log(`Not the users first contribution.`);\n return;\n }\n const message = isIssue ? issueMessage : prMessage;\n // Add a comment to the appropriate place\n if (isIssue) {\n const issueNumber = context.payload.issue.number;\n console.log(`Adding message: ${message} to issue #${issueNumber}`);\n await github.rest.issues.createComment({\n owner: context.payload.repository.owner.login,\n repo: context.payload.repository.name,\n issue_number: issueNumber,\n body: message\n });\n }\n else {\n const pullNumber = context.payload.pull_request.number;\n console.log(`Adding message: ${message} to pull request #${pullNumber}`);\n await github.rest.pulls.createReview({\n owner: context.payload.repository.owner.login,\n repo: context.payload.repository.name,\n pull_number: pullNumber,\n body: message,\n event: 'COMMENT'\n });\n }\n" }, { "path": ".gitignore", "content": "*-debug.log\n*-error.log\n.DS_Store\n.idea\n/.nyc_output\n/dist\n/dist/\n/lib\n/node_modules/\n/tmp\n/yarn.lock\n/assets/examples/**\n!assets/examples/default-example.yaml\n!assets/examples/tutorial.yml'\n!assets/examples/default-example.json\nnode_modules\n/test/integration/generate/models/\ntest.asyncapi-cli\nasyncapi.json\ntest/fixtures/minimaltemplate/__transpiled\ntest/fixtures/newtemplate/__transpiled\ntest/fixtures/specification-conv.yml\ntest/fixtures/specification-conv.yaml\ntest/fixtures/specification-conv.json\n.vscode\nsrc/domains/models/generate/ClientLanguages.ts\n\n/action/\n/github-action/output/\n\noclif.manifest.json\nspec-examples.zip\n\n# Coverage for testing\n\ncoverage\n.asyncapi-analytics\n\n# Analytics\n\n.asyncapi-analytics\n\n# Modelina\ntest/fixtures/generate/models\n" }, { "path": ".prettierrc", "content": "{\n \"singleQuote\": true\n}" }, { "path": ".sonarcloud.properties", "content": "sonar.exclusions=test/**/*,Dockerfile,github-action/Dockerfile\nsonar.issue.ignore.multicriteria=e1,e2\n\n# Exclude copy recursively and root user issue in Dockerfile\nsonar.issue.ignore.multicriteria.e1.ruleKey=docker:S6470\nsonar.issue.ignore.multicriteria.e1.resourceKey=**/Dockerfile\n\nsonar.issue.ignore.multicriteria.e2.ruleKey=docker:S6471\nsonar.issue.ignore.multicriteria.e2.resourceKey=**/Dockerfile\n" }, { "path": "CHANGELOG.md", "content": "# @asyncapi/cli\n\n## 6.0.0\n\n### Major Changes\n\n- 7580cee: Removal of postman -> asyncapi conversion functionality\n\n ## ⚠ BREAKING CHANGES\n\n Remove postman conversion utilities due to unmaintained dependencies and compatibility issues.\n\n **Why this change?**\n - The `postman2openapi` dependency causes multiple issues due to its WASM involvement\n - WASM file loading causes browser compatibility issues after webpack updates\n - Alternative libraries like `postman-to-openapi` did not provide adequate functionality\n - The underlying dependencies are unmaintained and pose long-term maintenance risks\n\n **Impact:**\n - The `convert` command no longer supports postman format conversion\n - Users relying on postman conversion will need to find alternative solutions\n\n **Future:**\n We can consider re-adding this feature after community discussion and establishing a sustainable maintenance plan with actively maintained dependencies.\n\n Related: https://github.com/asyncapi/converter-js/pull/311\n\n## 5.0.7\n\n### Patch Changes\n\n- 72fd21f: Bump @asyncapi/generator from v3.1.0 → v3.1.1\n\n## 5.0.6\n\n### Patch Changes\n\n- a414293: - Updated `@asyncapi/generator` from `3.0.1` → `3.1.0`\n\n## 5.0.5\n\n### Patch Changes\n\n- be7c41d: chore: bump Node.js version to 24 in remaining Dockerfiles\n\n## 5.0.4\n\n### Patch Changes\n\n- cacf566: Update server-api image to use Node 24.\n\n## 5.0.3\n\n### Patch Changes\n\n- 125e907: Update dependencies to the latest feasible ones thus eliminating vulnerabilities.\n\n## 5.0.2\n\n### Patch Changes\n\n- 4073175: - Alpine Releases have been fixed now.\n - Smaller docker image sizes and pruned dependencies.\n\n## 5.0.1\n\n### Patch Changes\n\n- 394967f: fix: remove unnecessary await from startPreview call\n\n The startPreview function returns void, not a Promise, so awaiting it\n was incorrect and triggered a linter error. This matches the pattern\n used in the studio command.\n\n## 5.0.0\n\n### Major Changes\n\n- dac7bb4: Removed support for AsyncAPI Generator v1 and v2. The CLI now exclusively uses Generator v3. The `--use-new-generator` flag has been removed from the `generate fromTemplate` command.\n\n- b90a9b7: ## Major release with important security updates\n - Keeping in mind the recent Shai-Hulud attack, we have adopted trusted publishing with NPM.\n - This requires us to use node >= 24 and npm >= 11\n - Next.js version is in sync with Studio, and is currently 14.2.35 deemed safe by CVE. [For more details](https://nextjs.org/blog/CVE-2025-66478)\n\n ### Breaking Changes\n - Node.js version 24 or higher is now required.\n - NPM version 11 or higher is now required.\n - Next.js version is now 14.2.35 or higher.\n - The CLI now exclusively uses Generator v3 only.\n - The `--use-new-generator` flag has been removed from the `generate fromTemplate` command.\n - Default template in action has been upgraded to `@asyncapi/markdown-template@2.0.0`\n\n Please make sure to update your environment accordingly before upgrading to this version.\n\n### Minor Changes\n\n- c648614: Studio updated to 1.1.0 with Next.js 14.2.35 in https://github.com/asyncapi/cli/pull/1922/changes\n\n## 4.1.3\n\n### Patch Changes\n\n- a77940f: fix: show the correct path to the newly created optimized file\n - e16ebf5: fix: show the correct path to the newly created optimized file\n\n## 4.1.2\n\n### Patch Changes\n\n- df62a63: fix: generate optimized output corresponding to the input format\n - c756765: fix: generate optimized output corresponding to the input format\n\n## 4.1.1\n\n### Patch Changes\n\n- 8eca9ed: fix: update redoc\n - adde5d4: chore: update redoc\n\n Signed-off-by: Shurtu-gal \n\n## 4.1.0\n\n### Minor Changes\n\n- 70761f0: feat: add new custom resolver to fetch the reference from private repo\n - 88ceb3d: add new custom resolver to fetch the reference from private repo\n - 4974358: Update src/domains/services/validation.service.ts\n\n Co-authored-by: Fran Méndez \n - c764ee6: update instruction in the test case for the validation success\n - 2b9457f: fix test-cases\n - 86bbfc4: fix lint issue across the project\n - 6813ef0: Update 1875.md\n\n## 4.0.1\n\n### Patch Changes\n\n- 9b479fc: fix: lockfile fixed\n - 92bb81b: fix:lockfile fixed\n\n Signed-off-by: Tushar Anand \n\n## 4.0.0\n\n### Major Changes\n\n- 9d05d49: feat!: tests, flags and glee command code removed\n - 7df684f: chore: major tests flags and glee command code removed\n\n Signed-off-by: Tushar Anand \n - 4a94f51: chore:glee removal complete\n\n Signed-off-by: Tushar Anand \n\n## 3.6.0\n\n### Minor Changes\n\n- ca8101f: feat: output flag renamed and writing to file functionality added to diff command\n - 8c2e940: fix:parse flag output renamed to save-output and saving diff output to file functionality added to diff command\n\n Signed-off-by: Tushar Anand \n - 59e1df9: chore:tests added for flags save-output in validate and diff command\n\n Signed-off-by: Tushar Anand \n - 7228a36: chore:cleanup\n\n Signed-off-by: Tushar Anand \n - ccb5388: chore:cleanup\n\n Signed-off-by: Tushar Anand \n\n## 3.5.2\n\n### Patch Changes\n\n- bbc9451: fix: server-api deploy\n - 837be8a: fix: server-api release and deployment\n\n Signed-off-by: Shurtu-gal \n - 09af23e: chore: add app platform spec\n\n Signed-off-by: Shurtu-gal \n - a5eef9f: chore: install generator templates globally\n\n Signed-off-by: Shurtu-gal \n\n## 3.5.1\n\n### Patch Changes\n\n- 5a99f6f: fix: modify api:build script to generate languages\n - 9488a1b: fix: modify script to generate languages\n\n Updated the 'api:build' script to include language generation.\n\n## 3.5.0\n\n### Minor Changes\n\n- 129f531: Introduced a new `asyncapi generate client` command to the CLI.\n\n This command allows you to generate client libraries using the new **AsyncAPI Generator** baked-in templates. Read more about [baked-in templates in official documentation](https://www.asyncapi.com/docs/tools/generator/baked-in-templates).\n\n This feature is based on a new concept introduced in [AsyncAPI Generator version 2.8.3](https://github.com/asyncapi/generator/releases/tag/%40asyncapi%2Fgenerator%402.8.3). The number of templates is limited and the solution is still in the experimental phase. It is not recommended to use them in production. Instead, join us in the [Generator project](https://github.com/asyncapi/generator) to help improve templates with your use cases and your AsyncAPI documents.\n\n## 3.4.2\n\n### Patch Changes\n\n- d832abc: Fixes the dependencies and package-lock.json\n\n## 3.4.2\n\n### Patch Changes\n\n- 80dcadd: fix: get server-api release ready\n - 35248ba: chore: fix server-api release\n\n Signed-off-by: Shurtu-gal \n - 4dcdd02: fix: get server-api release ready\n\n Signed-off-by: Shurtu-gal \n\n## 3.4.1\n\n### Patch Changes\n\n- e2a3583: fix: made studio start on different port if one is already in use\n - 43a8cb8: fix: made studio start on differnt port if one is already in use\n\n Signed-off-by: Tushar Anand \n - ce4b061: Merge remote-tracking branch 'remote/master' into fix-studio-multiple-instance\n - 122812a: chore: new approach for port allocation done\n\n Signed-off-by: Tushar Anand \n - 5946001: fix: removed comment and fix linting errors\n\n Signed-off-by: Tushar Anand \n\n## 3.4.0\n\n### Minor Changes\n\n- 6b00166: feat: asyncapi release for alpine distros\n - 54ba750: feat: asyncapi on alpine distros\n - 44d72c3: fix: rename the scripts to use rename instead of tarballs\n\n## 3.3.0\n\n### Minor Changes\n\n- c944268: feat: refactor CLI to be service based and initial migration of server-api\n - ac95777: feat: refactor cli to be service based and migrate server-api\n\n Signed-off-by: Shurtu-gal \n - 6b925f4: chore: fix diff test\n\n Signed-off-by: Shurtu-gal \n - cfe6e8d: feat: add generator controller\n\n Signed-off-by: Shurtu-gal \n - b2d7bcc: chore: don't need to install everytime\n\n Signed-off-by: Shurtu-gal \n - dd71d22: Merge remote-tracking branch 'origin/master' into refactor\n - 1fd1216: fix: linting\n\n Signed-off-by: Ashish Padhy \n - 6bd3e73: chore: run prettier\n\n Signed-off-by: Ashish Padhy \n - ca3fdee: chore: run linter\n\n Signed-off-by: Ashish Padhy \n - 1d03d79: chore: quick startup of server-api\n\n Signed-off-by: Shurtu-gal \n - 13729bb: chore: rename to apps\n\n Signed-off-by: Ashish Padhy \n - cdd2a43: chore: rename npm commands\n\n Signed-off-by: Ashish Padhy \n - 90aca02: Merge remote-tracking branch 'remote/master' into refactor\n\n## 3.2.0\n\n### Minor Changes\n\n- 0754d1d: feat: add new feature to supress the warnings\n - ab94c15: Add a new flag that is --x-suppress-warnings to supress the warning in the validate command\n - 55819cd: Allow to pass multiple warnings to supress and add check to verify the warning is correct or not\n - 885fc71: Update src/core/parser.ts\n\n Co-authored-by: Souvik De \n - 16b22de: Update src/core/flags/validate.flags.ts\n\n Co-authored-by: Souvik De \n - de1caad: Add another flag to supressallwarnings and update test case\n\n## 3.1.1\n\n### Patch Changes\n\n- 152c272: feat: made the start studio command interactive along with addition of…\n - 0e8e3c1: feat: made the start studio command inteactive along with addition of a flag to disable prompt.\n\n## 3.1.0\n\n### Minor Changes\n\n- d17aa54: feat: new command `asyncapi start preview` has been added\n\n## 3.0.1\n\n### Patch Changes\n\n- 1b62a66: - Fixes script detection issue in version 3.0.0\n - Fixes testing by testing the github action with local CLI\n\n## 3.0.0\n\n### Major Changes\n\n- b6f8b82: feat: add autocomplete feature in cli\n\n## 2.17.0\n\n### Minor Changes\n\n- f0268d4: Remove `--renderer` flag and make `React` as the de-facto renderer, deprecating `Nunjucks`\n\n## 2.16.10\n\n### Patch Changes\n\n- e11fe05: fix: Wrong Error message in -h command #1725\n\n## 2.16.9\n\n### Patch Changes\n\n- 819b585: [Fix]: Json file supported in asyncapi new file command\n- 830fe82: Fix studio not opening in CLI studio command\n- 830fe82: fix: studio command not working\n\n## 2.16.8\n\n### Patch Changes\n\n- 460c99a: feat: use next.js version of studio\n- 460c99a: Upgrade studio to latest and allow use of next server\n\n## 2.16.7\n\n### Patch Changes\n\n- 6ca17b3: fix: update packages to latest stable version\n\n## 2.16.6\n\n### Patch Changes\n\n- 82b441f: fix: resolve error in AsyncAPI optimize\n\n## 2.16.5\n\n### Patch Changes\n\n- f873423: docs: update docs regarding asyncapi new command\n- 2deeb36: fix: print in cli asyncapi generate models without -o flag\n\n## 2.16.4\n\n### Patch Changes\n\n- 67d7e8f: fix: proxy implementation for optimize validate and convert fixed\n\n## 2.16.3\n\n### Patch Changes\n\n- cec8081: feat: added Proxy support for the generate commands.\n\n## 2.16.2\n\n### Patch Changes\n\n- 755339a: feat: change the implementation of new command\n\n## 2.16.1\n\n### Patch Changes\n\n- 3ab019f: chore(deps): bump jsonpath-plus and @stoplight/spectral-core\n- 07514e6: implemented new UI/UX improvements in config command\n- a774ae2: fix: starting of studio fixed when using example with new file\n\n## 2.16.0\n\n### Minor Changes\n\n- a37e124: Deprecate the --file flag in `start studio` command\n\n## 2.15.0\n\n### Minor Changes\n\n- dcfb8c7: fix: Remove unused package lodash.template\n\n## 2.14.1\n\n### Patch Changes\n\n- 08afb45: Prepare github action for release\n- da64c63: ci: bump artifact actions to v4\n\n## 2.14.0\n\n### Minor Changes\n\n- 6839c8f: - Changed docker build to a source code based build\n - Changed name of github action to avoid clash\n - Fixed Docker and Release Pipeline\n\n## 2.13.1\n\n### Patch Changes\n\n- 8ae33c4: Handle AsyncAPI v3 in diff command\n\n## 2.13.0\n\n### Minor Changes\n\n- a76b0fb: Add github-action to monorepo and set up changesets\n\n### Patch Changes\n\n- 81b925e: Updated README with Development.md file\n" }, { "path": "CODEOWNERS", "content": "# This file provides an overview of code owners in this repository.\n\n# Each line is a file pattern followed by one or more owners.\n# The last matching pattern has the most precedence.\n# For more details, read the following article on GitHub: https://help.github.com/articles/about-codeowners/.\n\n# The default owners are automatically added as reviewers when you open a pull request unless different owners are specified in the file.\n* @Souvikns @Amzani @Shurtu-gal @asyncapi-bot-eve @AayushSaini101\n" }, { "path": "CODE_OF_CONDUCT.md", "content": "\n# Contributor Covenant 3.0 Code of Conduct\n\n## Our Pledge\n\nWe pledge to make our community welcoming, safe, and equitable for all.\n\nWe are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.\n\n## Encouraged Behaviors\n\nWhile acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.\n\nWith these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:\n\n1. Respecting the **purpose of our community**, our activities, and our ways of gathering.\n2. Engaging **kindly and honestly** with others.\n3. Respecting **different viewpoints** and experiences.\n4. **Taking responsibility** for our actions and contributions.\n5. Gracefully giving and accepting **constructive feedback**.\n6. Committing to **repairing harm** when it occurs.\n7. Behaving in other ways that promote and sustain the **well-being of our community**.\n\n\n## Restricted Behaviors\n\nWe agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.\n\n1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.\n2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.\n3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.\n4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.\n5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.\n6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.\n7. Behaving in other ways that **threaten the well-being** of our community.\n\n### Other Restrictions\n\n1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.\n2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.\n3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.\n4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.\n\n\n## Reporting an Issue\n\nTensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.\n\nWhen an incident does occur, it is important to report it promptly. To report a possible violation, here are a few simple ways to do it: \n\n- Join our [AsyncAPI Slack](https://asyncapi.com/slack-invite) and share your report in the `#coc` channel. \n- Reach out directly to any member of the [Code of Conduct Committee](https://github.com/orgs/asyncapi/teams/code_of_conduct).\n- Or, if you’d prefer, just send us an email at **conduct@asyncapi.com**.\n\nCommunity Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.\n\n\n## Addressing and Repairing Harm\n\n****\n\nIf an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.\n\n1) Warning\n 1) Event: A violation involving a single incident or series of incidents.\n 2) Consequence: A private, written warning from the Community Moderators.\n 3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.\n2) Temporarily Limited Activities\n 1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.\n 2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.\n 3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.\n3) Temporary Suspension\n 1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.\n 2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.\n 3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.\n4) Permanent Ban\n 1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.\n 2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.\n 3) Repair: There is no possible repair in cases of this severity.\n\nThis enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.\n\n\n## Scope\n\nThis Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.\n\n\n## Attribution\n\nThis Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).\n\nContributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)\n\nFor answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion)." }, { "path": "CONTRIBUTING.md", "content": "# Contributing to AsyncAPI\nWe love your input! We want to make contributing to this project as easy and transparent as possible.\n\n## Contribution recogniton\n\nWe use [All Contributors](https://allcontributors.org/docs/en/specification) specification to handle recognitions. For more details read [this](https://www.asyncapi.com/docs/community/010-contribution-guidelines/recognize-contributors#main-content) document.\n\n\n\n\n## Summary of the contribution flow\n\nThe following is a summary of the ideal contribution flow. Please, note that Pull Requests can also be rejected by the maintainers when appropriate.\n\n```\n ┌───────────────────────┐\n │ │\n │ Open an issue │\n │ (a bug report or a │\n │ feature request) │\n │ │\n └───────────────────────┘\n ⇩\n ┌───────────────────────┐\n │ │\n │ Open a Pull Request │\n │ (only after issue │\n │ is approved) │\n │ │\n └───────────────────────┘\n ⇩\n ┌───────────────────────┐\n │ │\n │ Your changes will │\n │ be merged and │\n │ published on the next │\n │ release │\n │ │\n └───────────────────────┘\n```\n\n## Code of Conduct\nAsyncAPI has adopted a [Code of Conduct](./CODE_OF_CONDUCT.md) that we expect project participants to adhere to. Please read it carefully to understand what sort of behaviour is expected.\n\n## Our Development Process\nWe use Github to host code, to track issues and feature requests, as well as accept pull requests.\n\n## Issues\n[Open an issue](https://github.com/asyncapi/asyncapi/issues/new) **only** if you want to report a bug or a feature. Don't open issues for questions or support, instead join our [Slack workspace](https://www.asyncapi.com/slack-invite) and ask there. Don't forget to follow our [Slack Etiquette](https://www.asyncapi.com/docs/community/060-meetings-and-communication/slack-etiquette) while interacting with community members! It's more likely you'll get help, and much faster!\n\n## Bug Reports and Feature Requests\n\nPlease use our issues templates that provide you with hints on what information we need from you to help you out.\n\n## Pull Requests\n\n**Please, make sure you open an issue before starting with a Pull Request, unless it's a typo or a really obvious error.** Pull requests are the best way to propose changes to the specification. Get familiar with our document that explains [Git workflow](https://www.asyncapi.com/docs/community/010-contribution-guidelines/git-workflow) used in our repositories.\n\n## Conventional commits\n\nOur repositories follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) specification. Releasing to GitHub and NPM is done with the support of [semantic-release](https://semantic-release.gitbook.io/semantic-release/).\n\nPull requests should have a title that follows the specification, otherwise, merging is blocked. If you are not familiar with the specification simply ask maintainers to modify. You can also use this cheatsheet if you want:\n\n- `fix: ` prefix in the title indicates that PR is a bug fix and PATCH release must be triggered.\n- `feat: ` prefix in the title indicates that PR is a feature and MINOR release must be triggered.\n- `docs: ` prefix in the title indicates that PR is only related to the documentation and there is no need to trigger release.\n- `chore: ` prefix in the title indicates that PR is only related to cleanup in the project and there is no need to trigger release.\n- `test: ` prefix in the title indicates that PR is only related to tests and there is no need to trigger release.\n- `refactor: ` prefix in the title indicates that PR is only related to refactoring and there is no need to trigger release.\n\nWhat about MAJOR release? just add `!` to the prefix, like `fix!: ` or `refactor!: `\n\nPrefix that follows specification is not enough though. Remember that the title must be clear and descriptive with usage of [imperative mood](https://chris.beams.io/posts/git-commit/#imperative).\n\nHappy contributing :heart:\n\n## License\nWhen you submit changes, your submissions are understood to be under the same [Apache 2.0 License](https://github.com/asyncapi/asyncapi/blob/master/LICENSE) that covers the project. Feel free to [contact the maintainers](https://www.asyncapi.com/slack-invite) if that's a concern.\n\n## References\nThis document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/master/CONTRIBUTING.md).\n" }, { "path": "DEVELOPMENT.md", "content": "# Development guide\n\nThis guide will help you set up the `cli` locally, run tests, and use Docker for isolated testing.\n\n## Getting started\n\n1. Fork & Clone the repository:\n\nFirst fork the repository from github and then clone it,\n\n```bash\ngit clone https://github.com/{your_username}/cli.git\ncd cli\n```\n\nAfter cloning the repository, you should setup the fork properly and configure the `remote` repository as described [here](https://github.com/asyncapi/community/blob/master/git-workflow.md)\n\n2. Install dependencies:\n\n```bash\nnpm install\n```\n\n## Running tests\n\n### Local testing\n\nTo run all tests locally:\n\n- CLI tests: `npm run cli:test`\n- Unit tests: `npm run unit:test`\n- Github action tests: `npm run action:test`\n- Single test file: `npm run test:one -- `\n\n### Adding tests\n\n1. Create new test files in the appropriate directory under `test/`:\n - Unit tests: `test/unit//.test.ts`\n - Integration tests: `test/integration/.test.ts`\n\n2. Follow the existing test patterns.\n\n3. Run your new tests using the commands mentioned above.\n\n> 📘 **For detailed debugging and testing guidelines**, see the [Debugging & Testing Guide](/docs/debugging-testing.md).\n\n## Release process\n\nTo release a major/minor/patch:\n\n### Conventional Commits:\n\nTo maintain a clear git history of commits and easily identify what each commit changed and whether it triggered a release, we use conventional commits. The feat and fix prefixes are particularly important as they are needed to trigger changesets. Using these prefixes ensures that the changes are correctly categorized and the versioning system functions as expected.\n\nFor Example:\n```\nfeat: add new feature\n```\n \n#### Manual\n\n1. Create a new release markdown file in the `.changeset` directory. The filename should indicate what the change is about.\n \n2. Add the following content to the file in this particular format:\n\n ```markdown\n ---\n \"@package-name-1\": [type] (major/minor/patch)\n \"@package-name-2\": [type]\n ---\n\n [Provide a brief description of the changes. For example: Added a new Release GitHub Flow to the Turborepo. No new features or bugfixes were introduced.]\n ```\n\n For Example:\n \n ```markdown\n ---\n \"@asyncapi/cli\": minor\n ---\n\n Adding new Release Github Flow to the Turborepo. No new features or bugfixes were introduced.\n\n ```\n\n3. Include the file in your pull request.\n\n#### Using CLI\n\n1. Create a new release markdown file using changeset CLI. Below command will trigger an interactive prompt that you can use to specify release type and affected packages.\n ```cli \n npx -p @changesets/cli@2.27.7 changeset\n ```\n\n2. Include the file in your pull request.\n\n> [!TIP]\n> For more detailed instructions, you can refer to the official documentation for creating a changeset:\n[Adding a changeset](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md)\n\n### Release Flow:\n\n1. **Add a Changeset**:\n - When you make changes that need to be released, create a markdown file in the `.changeset` directory stating the package name and level of change (major/minor/patch). \n\n2. **Open a Pull Request**:\n - Push your changes and open a Pull Request (PR). After the PR is merged the changeset file helps communicate the type of changes (major, minor, patch).\n\n3. **CI Processes Changeset**:\n - After PR is merged, a dedicated GitHub Actions release workflow runs using changeset action,\n\n - This action reads the markdown files in the `.changeset` folder and creates a PR with the updated version of the package and removes the markdown file. For example:\n\n Before:\n ```json\n \"name\": \"@asyncapi/cli\",\n \"version\": \"2.0.1\",\n ```\n\n After:\n ```json\n \"name\": \"@asyncapi/cli\",\n \"version\": \"3.0.1\",\n ```\n\n - The new PR will also contain the description from the markdown files,\n\n - AsyncAPI bot automatically merge such release PR.\n\n4. **Release the Package**:\n\n - After the PR is merged, the CI/CD pipeline triggers again. The `changesets/action` step identifies that the PR was created by itself. It then verifies if the current version of the package is greater than the previously released version. If a difference is detected, it executes the publish command to release the updated package.\n\n## Additional commands\n\n- Lint the code: `npm run lint`\n- Build Docker image: `npm run docker:build`\n\n## Troubleshooting\n\nIf you encounter any issues during development or testing, please check the following:\n\n1. Ensure you're using the correct Node.js version (24.0.0 or higher) and npm version (8.19.0 or higher).\n2. Clear the `node_modules` directory and reinstall dependencies if you encounter unexpected behavior.\n3. For Docker-related issues, make sure Docker is running and you have sufficient permissions.\n4. For permission errors, try: `sudo chown -R $(whoami) ./lib ./node_modules`\n5. For path alias issues, rebuild the project: `npm run build`\n\n> 📘 **For comprehensive debugging help**, see the [Debugging & Testing Guide](/docs/debugging-testing.md).\n\nIf problems persist, please open an issue on the GitHub repository.\n" }, { "path": "Dockerfile", "content": "FROM node:24-alpine AS build\n\n# Copy the source code\nCOPY ./ /tmp/source_code\n\n# Install dependencies\nRUN cd /tmp/source_code && npm install --ignore-scripts\n\n# Build the source code\nRUN cd /tmp/source_code && npm run build\n\n# create libraries directory\nRUN mkdir -p /libraries\n\n# Copy the lib, bin, node_modules, and package.json files to the /libraries directory\nRUN cp -r /tmp/source_code/lib /libraries\nRUN cp -r /tmp/source_code/assets /libraries\nRUN cp /tmp/source_code/package.json /libraries\nRUN cp /tmp/source_code/package-lock.json /libraries\nRUN cp /tmp/source_code/oclif.manifest.json /libraries\n\n# Copy the bin directory to the /libraries directory\nRUN cp -r /tmp/source_code/bin /libraries\n\n# Remove everything inside /tmp\nRUN rm -rf /tmp/*\n\nFROM node:24-alpine\n\n# Set ARG to explicit value to build chosen version. Default is \"latest\"\nARG ASYNCAPI_CLI_VERSION=\n\n# Create a non-root user\nRUN addgroup -S myuser && adduser -S myuser -G myuser\n\nWORKDIR /app\n\n# Since 0.14.0 release of html-template chromium is needed for pdf generation\nENV PUPPETEER_EXECUTABLE_PATH /usr/bin/chromium-browser\nENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD true\n# Since 0.30.0 release Git is supported and required as a dependency\n# Since 0.14.0 release of html-template chromium is needed for pdf generation.\n# More custom packages for specific template should not be added to this dockerfile. Instead, we should come up with some extensibility solution.\nRUN apk --update add git chromium && \\\n apk add --no-cache --virtual .gyp python3 make g++ && \\\n rm -rf /var/lib/apt/lists/* && \\\n rm /var/cache/apk/*\n\n# Copy the libraries directory from the build stage\nCOPY --from=build /libraries /libraries\n\n# Install the dependencies\nRUN cd /libraries && npm install --omit=dev --ignore-scripts\n\n# Create a script that runs the desired command\nRUN ln -s /libraries/bin/run_bin /usr/local/bin/asyncapi\n\n# Make the script executable\nRUN chmod +x /usr/local/bin/asyncapi\n\n# Change ownership to non-root user\nRUN chown -R myuser:myuser /libraries /usr/local/bin/asyncapi || echo \"Failed to change ownership\"\n\nRUN chown -R myuser:myuser /usr/local/lib/node_modules && \\\nchown -R myuser:myuser /usr/local/bin\n\n# Switch to the non-root user\nUSER myuser\n\nENTRYPOINT [ \"asyncapi\" ]\n" }, { "path": "LICENSE", "content": " Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright [yyyy] [name of copyright owner]\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License." }, { "path": "NOTICE", "content": "Copyright 2016-2025 AsyncAPI Initiative\n\nThis product includes software developed at\nAsyncAPI Initiative (http://www.asyncapi.com/)." }, { "path": "README.md", "content": "[![AsyncAPI CLI](./assets/logo.png)](https://www.asyncapi.com/tools/cli)\n\nCLI to work with your AsyncAPI files. Currently under development, we are working to bring more features. \n\n[![GitHub license](https://img.shields.io/github/license/asyncapi/cli)](https://github.com/asyncapi/cli/blob/master/LICENSE)\n[![PR testing - if Node project](https://github.com/asyncapi/cli/actions/workflows/if-nodejs-pr-testing.yml/badge.svg)](https://github.com/asyncapi/cli/actions/workflows/if-nodejs-pr-testing.yml)\n[![npm](https://img.shields.io/npm/dw/@asyncapi/cli)](https://www.npmjs.com/package/@asyncapi/cli)\n\n## Table of contents\n\n\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Architecture](#architecture)\n- [Debugging & Testing](#debugging--testing)\n- [Github Action](#github-action)\n- [Contributing](#contributing)\n * [Set up development environment](#set-up-development-environment)\n * [Command Structure and Patterns](#command-structure-and-patterns)\n- [Contributors](#contributors)\n\n\n\n## Installation\nLearn how to install the AsyncAPI CLI by following the instructions in the [installation guide](/docs/installation.md). \n\n## Usage\nThe [usage guide](/docs/usage.md) provides information about different ways to use the CLI.\n\n## Architecture\nThe [architecture guide](/docs/architecture.md) provides information about the architecture.\n\n## Debugging & Testing\nThe [debugging & testing guide](/docs/debugging-testing.md) provides step-by-step instructions for debugging CLI commands, API endpoints, and services, along with comprehensive testing guidelines.\n\n## Github Action\n\nThe AsyncAPI CLI can be used as a GitHub Action. You can find more information in the [GitHub Action guide](https://www.asyncapi.com/docs/tools/cli/github-action).\n\n## Contributing\n\nRead [CONTRIBUTING](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md) guide.\n\n### Set up development environment\n\nRead [DEVELOPMENT.md](/DEVELOPMENT.md) file for development setup.\n\nAdditional steps:\n\n- Run `npm run test` to make sure everything is properly set up\n- Run `npm run build` and then `bin/run` to try new CLI locally\n\nThe UX developed for the CLI should comply with the [Command Line Interface Guideline](https://clig.dev/)\n\n### Command Structure and Patterns\n\nWe are following `verb + noun` and `namespace + noun + [verb]` pattern for making our commands and arguments. For example `asyncapi validate ` and `asyncapi config context add `.\n\n## Contributors\n\nThanks go to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\"Jorge
Jorge Aguiar Martín
💻 🤔 ⚠️ 📖		\"Lukasz
Lukasz Gornicki
🤔 💻 👀 🚧		\"souvik\"/
souvik
💻 🤔 ⚠️ 👀 🚧 📖		\"David
David Boyne
💻 🤔 🚧		\"Fran
Fran Méndez
💻 🤔 👀		\"Maciej
Maciej Urbańczyk
👀 🚧 🤔		\"Aayush
Aayush Kumar Sahu
💻 ⚠️
\"Mihir
Mihir Kulkarni
💻		\"Abir\"/
Abir
⚠️ 💻		\"Peter
Peter Ramos
💻		\"Samriddhi\"/
Samriddhi
⚠️		\"Pranay
Pranay Kharabe
💻		\"Damilola
Damilola Oladele
📖		\"Abhay
Abhay Garg
💻 ⚠️
\"Sambhav
Sambhav Gupta
💻 ⚠️		\"Hippolyte
Hippolyte Vergnol
💻 🚇		\"Jente
Jente Vets
💻		\"Rishi\"/
Rishi
💻		\"Ashish
Ashish Padhy
💻		\"Meet
Meet Agrawal
🚇		\"Chinmay
Chinmay Shewale
💻 ⚠️
\"Mahfuza
Mahfuza Humayra Mohona
📖		\"Heiko
Heiko Henning
💻		\"Zack_Aayush\"/
Zack_Aayush
💻		\"Ayush
Ayush Nautiyal
💻		\"AnishKacham\"/
AnishKacham
💻		\"Viacheslav
Viacheslav Turovskyi
💻		\"Amanpreet
Amanpreet Singh Bedi
💻
\"Debajyoti
Debajyoti Halder
💻		\"Savio
Savio Dias
💻		\"Jonas
Jonas Lagoni
💻 🤔 👀 ⚠️		\"Khuda
Khuda Dad Nomani
💻 📖		\"Sergio
Sergio Moya
💻		\"Vishal
Vishal Sharma
💻
\n\n\n\n\n\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n" }, { "path": "action-template.yml", "content": "name: 'AsyncAPI CLI Action'\ndescription: 'One stop solution for all your AsyncAPI Specification needs in github actions.'\ninputs:\n cli_version:\n description: 'Version of AsyncAPI CLI to be used. This is only needed if you want to test with a specific version of AsyncAPI CLI. Default is latest which is also the recommended option.'\n required: false\n default: ''\n command:\n description: 'Command to run. Available commands in action :- generate, validate, convert, optimize and custom. Default is generate. For custom command, provide the whole command as input. List of available commands can be found in https://www.asyncapi.com/docs/tools/cli/usage.'\n required: false\n default: 'generate'\n filepath:\n description: 'Path to AsyncAPI document. This input is required if command is set to generate, validate, convert or optimize. Default is ./asyncapi.yaml'\n required: false\n default: 'asyncapi.yml'\n template:\n description: 'Template for the generator. Official templates are listed here https://github.com/search?q=topic%3Aasyncapi+topic%3Agenerator+topic%3Atemplate. You can pass template as npm package, url to git repository, link to tar file or local template.'\n default: '@asyncapi/markdown-template@2.0.0'\n required: false\n language:\n description: 'Language of the generated code. This input is required if you want to generate models. List of available languages can be found in https://www.asyncapi.com/docs/tools/cli/usage#asyncapi-generate-models-language-file'\n required: false\n default: ''\n output:\n description: 'Directory where to put the generated files. Can be used only with generate or convert commands. Default is output.'\n required: false\n default: 'output'\n parameters:\n description: 'The command that you use might support and even require specific parameters to be passed to the CLI for the generation. Template parameters should be preceded by -p'\n required: false\n default: ''\n custom_command:\n description: 'Custom command to be run. This input is required if command is set to custom.'\n required: false\n default: ''\n\nruns:\n using: 'docker'\n # This is the image that will be used to run the action.\n # IMPORTANT: The version has to be changed manually in your PRs.\n image: 'docker://asyncapi/github-action-for-cli:${ version }'\n args:\n - ${{ inputs.cli_version }}\n - ${{ inputs.command }}\n - ${{ inputs.filepath }}\n - ${{ inputs.template }}\n - ${{ inputs.language }}\n - ${{ inputs.output }}\n - ${{ inputs.parameters }}\n - ${{ inputs.custom_command }}\n\nbranding:\n icon: 'file-text'\n color: purple\n" }, { "path": "action.yml", "content": "name: 'AsyncAPI CLI Action'\ndescription: 'One stop solution for all your AsyncAPI Specification needs in github actions.'\ninputs:\n cli_version:\n description: 'Version of AsyncAPI CLI to be used. This is only needed if you want to test with a specific version of AsyncAPI CLI. Default is latest which is also the recommended option.'\n required: false\n default: ''\n command:\n description: 'Command to run. Available commands in action :- generate, validate, convert, optimize and custom. Default is generate. For custom command, provide the whole command as input. List of available commands can be found in https://www.asyncapi.com/docs/tools/cli/usage.'\n required: false\n default: 'generate'\n filepath:\n description: 'Path to AsyncAPI document. This input is required if command is set to generate, validate, convert or optimize. Default is ./asyncapi.yaml'\n required: false\n default: 'asyncapi.yml'\n template:\n description: 'Template for the generator. Official templates are listed here https://github.com/search?q=topic%3Aasyncapi+topic%3Agenerator+topic%3Atemplate. You can pass template as npm package, url to git repository, link to tar file or local template.'\n default: '@asyncapi/markdown-template@2.0.0'\n required: false\n language:\n description: 'Language of the generated code. This input is required if you want to generate models. List of available languages can be found in https://www.asyncapi.com/docs/tools/cli/usage#asyncapi-generate-models-language-file'\n required: false\n default: ''\n output:\n description: 'Directory where to put the generated files. Can be used only with generate or convert commands. Default is output.'\n required: false\n default: 'output'\n parameters:\n description: 'The command that you use might support and even require specific parameters to be passed to the CLI for the generation. Template parameters should be preceded by -p'\n required: false\n default: ''\n custom_command:\n description: 'Custom command to be run. This input is required if command is set to custom.'\n required: false\n default: ''\n\nruns:\n using: 'docker'\n # This is the image that will be used to run the action.\n # IMPORTANT: The version has to be changed manually in your PRs.\n image: 'docker://asyncapi/github-action-for-cli:6.0.0'\n args:\n - ${{ inputs.cli_version }}\n - ${{ inputs.command }}\n - ${{ inputs.filepath }}\n - ${{ inputs.template }}\n - ${{ inputs.language }}\n - ${{ inputs.output }}\n - ${{ inputs.parameters }}\n - ${{ inputs.custom_command }}\n\nbranding:\n icon: 'file-text'\n color: purple\n" }, { "path": "assets/create-template/templates/default/asyncapi.yaml", "content": "asyncapi: 3.1.0\ninfo:\n title: Temperature Service\n version: 1.0.0\n description: This service is in charge of processing all the events related to temperature.\n\nservers:\n dev:\n url: test.mosquitto.org\n protocol: mqtt\n\nchannels:\n temperature/changed:\n description: Updates the bedroom temperature in the database when the temperature drops or goes up.\n publish:\n operationId: temperatureChange\n message:\n description: Message that is being sent when the temperature in the bedroom changes.\n contentType: application/json\n payload:\n type: object\n additionalProperties: false\n properties:\n temperatureId:\n type: string\n\ncomponents:\n schemas:\n temperatureId:\n type: object\n additionalProperties: false\n properties:\n temperatureId:\n type: string\n" }, { "path": "assets/create-template/templates/default/package.json", "content": "{\n \"name\": \"myTemplate\",\n \"generator\": {\n \"renderer\": \"react\",\n \"supportedProtocols\": []\n },\n \"dependencies\": {\n \"@asyncapi/generator-react-sdk\": \"^1.1.2\"\n }\n}\n" }, { "path": "assets/create-template/templates/default/readme.md", "content": "### First install all the dependencies for template using below command:\nnpm install \n### Run the template using for a specific asyncapi document \n asyncapi generate fromTemplate ../asyncapi-template " }, { "path": "assets/create-template/templates/default/template/index.js", "content": "import { File, Text } from '@asyncapi/generator-react-sdk';\n\n// Pass the others parameters to get the specificatin of the asyncapi document\nexport default function ({ asyncapi }) {\n return (\n \n My application's markdown file.\n App name: **{asyncapi.info().title()}**\n \n );\n}\n" }, { "path": "assets/examples/default-example.json", "content": "{\n \"asyncapi\": \"3.1.0\",\n \"info\": {\n \"title\": \"Account Service\",\n \"version\": \"1.0.0\",\n \"description\": \"This service is in charge of processing user signups\"\n },\n \"channels\": {\n \"userSignedUp\": {\n \"address\": \"user/signedup\",\n \"messages\": {\n \"UserSignedUp\": {\n \"$ref\": \"#/components/messages/UserSignedUp\"\n }\n }\n }\n },\n \"operations\": {\n \"onUserSignUp\": {\n \"action\": \"receive\",\n \"channel\": {\n \"$ref\": \"#/channels/userSignedUp\"\n },\n \"messages\": [\n {\n \"$ref\": \"#/channels/userSignedUp/messages/UserSignedUp\"\n }\n ]\n }\n },\n \"components\": {\n \"messages\": {\n \"UserSignedUp\": {\n \"payload\": {\n \"type\": \"object\",\n \"properties\": {\n \"displayName\": {\n \"type\": \"string\",\n \"description\": \"Name of the user\"\n },\n \"email\": {\n \"type\": \"string\",\n \"format\": \"email\",\n \"description\": \"Email of the user\"\n }\n }\n }\n }\n }\n }\n }" }, { "path": "assets/examples/default-example.yaml", "content": "asyncapi: 3.1.0\ninfo:\n title: Account Service\n version: 1.0.0\n description: This service is in charge of processing user signups\nchannels:\n userSignedUp:\n address: user/signedup\n messages:\n UserSignedUp:\n $ref: '#/components/messages/UserSignedUp'\noperations:\n onUserSignUp:\n action: receive\n channel:\n $ref: '#/channels/userSignedUp'\n messages:\n - $ref: '#/channels/userSignedUp/messages/UserSignedUp'\ncomponents:\n messages:\n UserSignedUp:\n payload:\n type: object\n properties:\n displayName:\n type: string\n description: Name of the user\n email:\n type: string\n format: email\n description: Email of the user" }, { "path": "bin/dev", "content": "#!/usr/bin/env node\n\nconst oclif = require('@oclif/core')\n\nconst path = require('path')\nconst project = path.join(__dirname, '..', 'tsconfig.json')\n\n// In dev mode -> use ts-node and dev plugins\nprocess.env.NODE_ENV = 'development'\n\nrequire('ts-node').register({project})\n\n// In dev mode, always show stack traces\noclif.settings.debug = true;\n\n// Start the CLI\noclif.run().then(oclif.flush).catch(oclif.Errors.handle)\n" }, { "path": "bin/dev.cmd", "content": "@echo off\n\nnode \"%~dp0\\dev\" %*" }, { "path": "bin/run", "content": "#!/usr/bin/env node\n\nprocess.env.NODE_ENV = 'development';\n\nconst oclif = require('@oclif/core');\n\noclif.run()\n .then(require('@oclif/core/flush'))\n .catch((err) => {\n const { handle } = require('@oclif/core/handle');\n return handle(err);\n });\n" }, { "path": "bin/run.cmd", "content": "@echo off\n\nnode \"%~dp0\\run\" %*\n" }, { "path": "bin/run_bin", "content": "#!/usr/bin/env node\n\n// Only the binary installed through NPM is considered production environment. See \"bin\" in package.json.\nprocess.env.NODE_ENV = 'production';\n\nconst oclif = require('@oclif/core');\n\noclif.run()\n .then(require('@oclif/core/flush'))\n .catch((err) => {\n const { handle } = require('@oclif/core/handle');\n return handle(err);\n });\n" }, { "path": "bin/run_bin.cmd", "content": "@echo off\n\nnode \"%~dp0\\run_bin\" %*\n" }, { "path": "docs/architecture.md", "content": "---\ntitle: 'CLI Architecture'\nweight: 40\n---\n\n# CLI Architecture\n\n## Overview\n\nThe AsyncAPI CLI is built with [oclif](https://oclif.io/) and provides both command-line operations and a REST API server for working with AsyncAPI specifications.\n\n---\n\n## Architecture Diagram\n\n```\n┌─────────────────────────────────────────────────┐\n│ Entry Points │\n│ ┌──────────┐ ┌──────────┐ │\n│ │ CLI │ │ API │ │\n│ │ (oclif) │ │ (Express)│ │\n│ └────┬─────┘ └────┬─────┘ │\n└───────┼─────────────────────────┼───────────────┘\n └───────────┬─────────────┘\n ▼\n ┌───────────────────────┐\n │ Domain Services │\n │ Validation, Generator│\n │ Convert, Config │\n └───────────┬───────────┘\n ▼\n ┌───────────────────────┐\n │ Domain Models │\n │ Specification,Context│\n └───────────┬───────────┘\n ▼\n ┌───────────────────────┐\n │ Utilities │\n │ Logger, Helpers │\n └───────────────────────┘\n```\n\n---\n\n## Directory Structure\n\n```\nsrc/\n├── apps/\n│ ├── cli/ # CLI commands & internals\n│ └── api/ # REST API (Express)\n├── domains/\n│ ├── models/ # Specification, Context\n│ └── services/ # Business logic\n├── errors/ # Custom errors\n├── interfaces/ # TypeScript types\n└── utils/ # Utilities\n```\n\n---\n\n## Core Components\n\n### CLI Application\n\n| Component | Description |\n|-----------|-------------|\n| **Entry Points** | `bin/run` (dev), `bin/run_bin` (prod) |\n| **Base Command** | Metrics, parser integration, error handling |\n\n**Commands:**\n- **Core:** `validate`, `convert`, `format`, `optimize`, `diff`, `bundle`\n- **Generation:** `generate client`, `generate models`, `generate fromTemplate`\n- **Config:** `config context`, `config analytics`, `config versions`\n- **Utility:** `new file`, `new template`, `start api|studio|preview`, `pretty`\n\n### API Server\n\n**Endpoints:** `/v1/validate`, `/v1/parse`, `/v1/generate`, `/v1/convert`, `/v1/bundle`, `/v1/diff`, `/v1/docs`, `/v1/help`, `/v1/version`\n\n**Features:** Express with Helmet security, CORS, compression, RFC 7807 error responses\n\n### Domain Services\n\nAll services extend `BaseService` and return `ServiceResult`:\n\n| Service | Purpose |\n|---------|---------|\n| `ValidationService` | Validates specs with Spectral, calculates scores |\n| `GeneratorService` | Generates code/models |\n| `ConvertService` | Converts between AsyncAPI/OpenAPI formats |\n| `ConfigService` | Manages CLI config and contexts |\n| `ArchiverService` | Creates ZIP archives |\n\n### Domain Models\n\n| Model | Purpose |\n|-------|---------|\n| **Specification** | Loads from file, URL, or context; auto-detects `asyncapi.json\\|yml\\|yaml` |\n| **Context** | Manages multiple AsyncAPI contexts; stored in `~/.asyncapi/` |\n\n### Error Classes\n\n`ContextError`, `SpecificationFileError`, `ValidationError`, `GeneratorError`, `DiffError`\n\n---\n\n## Execution Flow\n\n**CLI Command:**\n```\nUser Command → oclif → Base Command → Domain Service → ServiceResult\n```\n\n**API Request:**\n```\nHTTP Request → Express → Controller → Domain Service → HTTP Response\n```\n\n---\n\n## Extension Points\n\n| Add | Steps |\n|-----|-------|\n| **New Command** | Create in `src/apps/cli/commands/`, extend `Command`, implement `run()` |\n| **New API Endpoint** | Create controller in `src/apps/api/controllers/`, register in `index.ts` |\n| **New Service** | Create in `src/domains/services/`, extend `BaseService`, return `ServiceResult` |\n\n---\n\n## Configuration\n\n| Config | Location |\n|--------|----------|\n| CLI Context | `~/.asyncapi/contexts.json`, `~/.asyncapi/.current` |\n| Analytics | `~/.asyncapi-analytics` |\n\n**Environment Variables:**\n- `NODE_ENV` — `development` | `production` | `test`\n- `PORT` — API server port (default: 3000)\n- `ASYNCAPI_METRICS_*` — Metrics configuration\n\n---\n\n## Technology Stack\n\n| Category | Technologies |\n|----------|--------------|\n| **Core** | oclif, TypeScript, Express |\n| **AsyncAPI** | @asyncapi/parser, generator, converter, bundler, diff, optimizer |\n| **Supporting** | winston, ajv, chalk, @clack/prompts |\n" }, { "path": "docs/autocompleteEnabled.md", "content": "---\ntitle: 'Auto-complete setup'\nweight: 30\n---\n\n# AsyncAPI CLI Autocomplete Setup\n\nThis guide provides steps to enable autocomplete for the AsyncAPI CLI. The setup supports `zsh`, `bash`, and `PowerShell` (manual setup only).\n\n## Automatic Setup (Post-Install Script)\nThe AsyncAPI CLI includes a post-install script that automatically configures autocomplete for supported shells (`zsh` and `bash`). No additional steps are required.\n\n### Steps:\n1. Ensure that AsyncAPI CLI is installed. You can verify by running:\n ```sh\n asyncapi --version\n ```\n If the command fails, install it using:\n ```sh\n npm install -g @asyncapi/cli\n ```\n\n\n2. Apply the changes by running:\n ```sh\n source ~/.bashrc # For bash\n source ~/.zshrc # For zsh\n ```\n\n3. Verify autocomplete by typing:\n ```sh\n asyncapi \n ```\n You should see command suggestions.\n\n## Manual Setup (For PowerShell and Troubleshooting)\nIf the automatic setup does not work or if you need to enable autocomplete manually (especially for PowerShell), follow these steps.\n\n### Steps:\n1. **Build the AsyncAPI CLI manually:**\n If you are working with the CLI project locally, you need to build it first:\n ```sh\n npm install\n npm run build\n ```\n\n2. **Run the autocomplete command manually:**\n ```sh\n ./bin/run autocomplete # Run this from the project root folder\n ```\n\n3. **Locate the AsyncAPI CLI executable:**\n Run the following command to find the executable path:\n ```sh\n which asyncapi # For bash/zsh\n Get-Command asyncapi | Select-Object -ExpandProperty Definition # For PowerShell\n ```\n If the command does not return a path, ensure AsyncAPI CLI is installed.\n\n4. **Generate and apply the autocomplete script:**\n Run the following command based on your shell:\n ```sh\n printf \"$(./bin/run autocomplete script bash)\" >> ~/.bashrc; source ~/.bashrc # For bash\n printf \"$(./bin/run autocomplete script zsh)\" >> ~/.zshrc; source ~/.zshrc # For zsh\n printf \"$(./bin/run autocomplete script powershell)\" >> $PROFILE; . $PROFILE # For PowerShell\n ```\n\n5. **Test autocomplete:**\n ```sh\n asyncapi \n ```\n If it works, autocomplete is successfully enabled!\n\n---\n\nIf you encounter any issues, ensure that your shell configuration file is correctly updated and sourced. Restart your terminal if necessary.\n\n" }, { "path": "docs/context.md", "content": "---\ntitle: 'Context concept'\nweight: 60\n---\n\n## Overview\n\nAsyncAPI CLI provides functionality called `context`. It's purpose is to help to work with AsyncAPI CLI in large projects where you do not have just one service exposing AsyncAPI document, but multiple.\n\nEvent driven architecture involves multiple actors, subscribers and publishers. One time you want to validate document **A** and the other time you want to generate models from document **B**. Every time you do it, you need to provide to AsyncAPI CLI the location of the AsyncAPI document, which might be time consuming. You can workaround it with aliases in bash profiles or with other solutions but it is better to use `context` feature, as you can then store it in your repository and share with other team members.\n\nIn short it means that for example instead of writing `asyncapi validate /some/folder/my-asyncapi.yml` you can create a context called `myasync` that will be an alias for and point to `/some/folder/my-asyncapi.yml`. This way next time you use the CLI you can do `asyncapi validate myasync`.\n\n## Context File location\n\nYou can have a global context for your workstation, and a project specific context.\n\nIf your use case is that you work with multiple repositories, you might want to use a global context. The `.asyncapi-cli` context file is then located in your home directory. You can also store your custom `.asyncapi-cli` file in your project with custom configuration. This way when you run `asyncapi config context add` inside your project, the new context is added to the context file under your project.\n\n## How to add context to a project\n\n### Manually\n - Create file `.asyncapi-cli` containing [minimal empty context file](#minimalEmptyContextFile) in:\n - current directory\n - root of current repository\n - user's home directory\n\n### Using CLI's `init` command\n\n`asyncapi config context init [CONTEXT-FILE-PATH]`\n\nWhere `[CONTEXT-FILE-PATH]` instructs CLI what directory should the file `.asyncapi-cli` containing [minimal empty context file](#minimalEmptyContextFile) be created in:\n - current directory: `asyncapi config context init .` (default)\n - root of current repository: `asyncapi config context init ./`\n - user's home directory: `asyncapi config context init ~`\n \n(if `[CONTEXT-FILE-PATH]` is omitted, empty context file is created in current directory)\n\nMake use of newly created `.asyncapi-cli` by executing command:\n\n`asyncapi config context add [CONTEXT-NAME] [SPEC-FILE-PATH]`\n\n### Setup example in a real project\n\nBelow you can see an example of context setup for [Event Driven Flight status notification service](https://github.com/amadeus4dev-examples/amadeus-async-flight-status/tree/ff433b6d320a3a6a2499976cbf0782353bc57c16) of the [Amadeus Airline Platform](https://amadeus.com/en/industries/airlines/airline-platform), with multiple microservices and their AsyncAPI documents.\n\n```bash\n# One-time initialization of '.asyncapi-cli' file\n(main)$ asyncapi config context init\nInitialized context /amadeus-async-flight-status/.asyncapi-cli\n\n# Adding first context\n(main)$ asyncapi config context add subscriber subscriber/asyncapi.yaml\nAdded context \"subscriber\".\nYou can set it as your current context: asyncapi config context use subscriber\nYou can use this context when needed by passing subscriber as a parameter: asyncapi validate subscriber\n\n# Adding more contexts\n(main)$ asyncapi config context add notifier notifier/asyncapi.yaml\nAdded context \"notifier\".\nYou can set it as your current context: asyncapi config context use notifier\nYou can use this context when needed by passing notifier as a parameter: asyncapi validate notifier\n\n(main)$ asyncapi config context add monitor monitor/asyncapi.yaml\nAdded context \"monitor\".\nYou can set it as your current context: asyncapi config context use monitor\nYou can use this context when needed by passing monitor as a parameter: asyncapi validate monitor\n\n# Setting monitor as default context\n(main)$ asyncapi config context use monitor\nmonitor is set as current\n\n# Now you do not even have to remember the context name, and default 'monitor/asyncapi.yaml' will be validated\n(main)$ asyncapi validate\nFile monitor/asyncapi.yaml is valid but has (itself and/or referenced documents) governance issues.\nmonitor/asyncapi.yaml\n 1:1 warning asyncapi-defaultContentType AsyncAPI document should have \"defaultContentType\" field.\n 1:1 warning asyncapi-id AsyncAPI document should have \"id\" field.\n 1:1 warning asyncapi2-tags AsyncAPI object should have non-empty \"tags\" array.\n 1:11 information asyncapi-latest-version The latest version of AsyncAPi is not used. It is recommended update to the \"2.6.0\" version. asyncapi\n 2:6 warning asyncapi-info-contact Info object should have \"contact\" object. info\n 19:15 warning asyncapi2-operation-operationId Operation should have an \"operationId\" field defined. channels.flight/update.subscribe\n 26:13 warning asyncapi2-operation-operationId Operation should have an \"operationId\" field defined. channels.flight/queue.publish\n✖ 7 problems (0 errors, 6 warnings, 1 info, 0 hints)\n\n# You can now use context name when running AsyncAPI commands, no need to remember file location like 'notifier/asyncapi.yaml'\n(main)$ asyncapi validate notifier\nFile notifier/asyncapi.yaml is valid but has (itself and/or referenced documents) governance issues.\nnotifier/asyncapi.yaml\n 1:1 warning asyncapi-defaultContentType AsyncAPI document should have \"defaultContentType\" field.\n 1:1 warning asyncapi-id AsyncAPI document should have \"id\" field.\n 1:1 warning asyncapi2-tags AsyncAPI object should have non-empty \"tags\" array.\n 1:11 information asyncapi-latest-version The latest version of AsyncAPi is not used. It is recommended update to the \"2.6.0\" version. asyncapi\n 2:6 warning asyncapi-info-contact Info object should have \"contact\" object. info\n 18:13 warning asyncapi2-operation-operationId Operation should have an \"operationId\" field defined. channels.flight/update.publish\n✖ 6 problems (0 errors, 5 warnings, 1 info, 0 hints)\n\n# Switch default context \n(main)$ asyncapi config context use notifier\nnotifier is set as current\n\n# List all contexts\n(main)$ asyncapi config context list\nmonitor: monitor/asyncapi.yaml\nnotifier: notifier/asyncapi.yaml\nsubscriber: subscriber/asyncapi.yaml\n```\n\n## Context File structure\n\n### Fixed Fields\n\nField Name | Type | Description\n---|:---:|---\ncurrent | `string` | An optional string value representing one of context names, which is used as default in CLI. Default means you can run CLI commands without providing context name, like `asyncapi validate`, and it will run against the default - `current` - context.\nstore | [Store Object](#storeObject) | **REQUIRED**. Map of filesystem paths to target AsyncAPI documents.\n\n### Store Object\n\nMap of filesystem paths to target AsyncAPI documents.\n\n**Patterned Fields**\n\nField Pattern | Type | Description\n---|:---:|---\n\\{contextName\\} | `string` | An optional string value representing filesystem path to the target AsyncAPI document.\n\n### Minimal Empty Context File\nRaw JSON:\n```\n{\n \"store\": {}\n}\n```\nStringified JSON:\n```\n{\"store\":{}}\n```\n\n### Context File Example\n\nExample of a context file for [Event Driven Flight status notification service](https://github.com/amadeus4dev-examples/amadeus-async-flight-status/tree/ff433b6d320a3a6a2499976cbf0782353bc57c16) of the [Amadeus Airline Platform](https://amadeus.com/en/industries/airlines/airline-platform), with multiple microservices and their AsyncAPI documents:\n```\n{\n \"current\": \"monitor\",\n \"store\": {\n \"monitor\": \"monitor/asyncapi.yaml\",\n \"notifier\": \"notifier/asyncapi.yaml\",\n \"subscriber\": \"subscriber/asyncapi.yaml\"\n }\n}\n```\n\n## More context related CLI options\n\nAll commands for managing contexts are available under `asyncapi config context` [CLI commands group](usage#asyncapi-config-context).\n" }, { "path": "docs/contributing-prs.md", "content": "---\ntitle: 'Contributing via Pull Requests'\nweight: 50\n---\n\n# Contributing via Pull Requests\n\n## Getting Started\n\n1. **Open an issue first** (unless it's a trivial fix)\n2. **Set up environment** — Follow [DEVELOPMENT.md](../DEVELOPMENT.md)\n3. **Create a branch** — Use prefixes: `feat/`, `fix/`, `docs/`, `refactor/`, `test/`, `chore/`\n\n---\n\n## PR Title Format\n\nFollow [Conventional Commits](https://www.conventionalcommits.org/):\n\n| Type | Description | Release |\n|------|-------------|---------|\n| `feat:` | New feature | MINOR |\n| `fix:` | Bug fix | PATCH |\n| `docs:` | Documentation | None |\n| `chore:` | Maintenance | None |\n| `test:` | Tests only | None |\n| `refactor:` | Code refactoring | None |\n\n**Breaking changes:** Add `!` → `feat!:`, `fix!:`\n\n**Examples:**\n- ✅ `feat: add AsyncAPI 3.0 validation support`\n- ✅ `fix: resolve context loading with special characters`\n- ❌ `Added new feature`\n- ❌ `fix bug`\n\n---\n\n## PR Checklist\n\n**Before submitting:**\n- [ ] Branch synced with `main`\n- [ ] `npm run build` passes\n- [ ] `npm run cli:test` passes\n- [ ] `npm run lint` passes (max 5 warnings)\n- [ ] Documentation updated (if needed)\n\n**Code quality:**\n- [ ] Follows existing code patterns\n- [ ] TypeScript types used (avoid `any`)\n- [ ] Error handling implemented\n- [ ] Tests added for new functionality\n- [ ] No `console.log` or commented code\n\n---\n\n## Code Standards\n\n| Area | Guideline |\n|------|-----------|\n| **TypeScript** | Explicit types, interfaces for objects, prefer `const` |\n| **Organization** | Follow existing structure, use path aliases (`@/`, `@cli/`, `@domains/`) |\n| **Errors** | Use custom errors from `src/errors/`, return `ServiceResult` from services |\n| **Commands** | Extend base `Command`, use domain services for business logic |\n\n---\n\n## Testing\n\n**Add tests for:**\n- New commands or API endpoints\n- Bug fixes (regression tests)\n- New domain services\n- Complex business logic\n\n```bash\nnpm run cli:test # All tests\nnpm run unit:test # Unit tests only\n```\n\n---\n\n## Best Practices\n\n| ❌ Avoid | ✅ Do |\n|----------|-------|\n| Large PRs (>500 lines) | Small, focused PRs |\n| Multiple concerns in one PR | One issue per PR |\n| Skipping tests | Comprehensive tests |\n| Hardcoded values | Externalize configuration |\n| Force push to main | Rebase instead of merge |\n\n---\n\n## Review Process\n\n1. CI runs automated checks\n2. Maintainers review code\n3. Address feedback promptly\n4. PR merged when approved\n\n---\n\n## Quick Reference\n\n```bash\n# Setup\nnpm install && npx lefthook install\n\n# Before PR\nnpm run build && npm run lint && npm run cli:test\n```\n\n**Quality over speed** — Write good code, tests, and documentation.\n" }, { "path": "docs/debugging-testing.md", "content": "---\ntitle: 'Debugging & Testing Guide'\nweight: 60\n---\n\n# Debugging & Testing Guide\n\nThis guide provides step-by-step instructions for debugging and testing the AsyncAPI CLI. Whether you're fixing a bug, adding a new feature, or understanding existing code, this document will help you navigate the debugging process effectively.\n\n## Table of Contents\n\n- [Project Structure Overview](#project-structure-overview)\n- [Setting Up Your Environment](#setting-up-your-environment)\n- [Debugging CLI Commands](#debugging-cli-commands)\n- [Debugging the API Server](#debugging-the-api-server)\n- [Debugging Services](#debugging-services)\n- [Writing Tests](#writing-tests)\n- [Running Tests](#running-tests)\n- [Common Issues & Solutions](#common-issues--solutions)\n- [Debugging Tools & Tips](#debugging-tools--tips)\n\n---\n\n## Project Structure Overview\n\nUnderstanding the codebase structure is essential for effective debugging:\n\n```\nsrc/\n├── apps/\n│ ├── api/ # REST API server (Express.js)\n│ │ ├── controllers/ # API endpoint handlers\n│ │ ├── middlewares/ # Request/response middleware\n│ │ └── exceptions/ # API error types\n│ └── cli/ # CLI application (oclif)\n│ ├── commands/ # CLI command implementations\n│ └── internal/ # Shared CLI utilities, flags, base classes\n├── domains/\n│ ├── models/ # Domain models (SpecificationFile, Context, etc.)\n│ └── services/ # Business logic services\n├── errors/ # Custom error classes\n├── utils/ # Utility functions\n└── interfaces/ # TypeScript interfaces\n\ntest/\n├── fixtures/ # Test data files (AsyncAPI specs, etc.)\n├── helpers/ # Test utilities\n├── integration/ # Integration tests for CLI commands\n└── unit/ # Unit tests for services and controllers\n ├── controllers/ # API controller tests\n ├── services/ # Service layer tests\n └── utils/ # Utility function tests\n```\n\n---\n\n## Setting Up Your Environment\n\n### 1. Install Dependencies\n\n```bash\nnpm install\n```\n\n### 2. Build the Project\n\n```bash\nnpm run build\n```\n\n### 3. Set Up Environment Variables for Debugging\n\nCreate a `.env` file or export variables:\n\n```bash\n# Enable development mode (verbose logging)\nexport NODE_ENV=development\n\n# Disable analytics during testing\nexport TEST=1\n\n# Set custom context file for testing\nexport CUSTOM_CONTEXT_FILENAME=\"test.asyncapi-cli\"\nexport CUSTOM_CONTEXT_FILE_LOCATION=\"\"\n```\n\n---\n\n## Debugging CLI Commands\n\n### Method 1: Using `bin/run` (Development Mode)\n\nThe `bin/run` script runs the CLI in development mode with TypeScript directly:\n\n```bash\n# Run any command with debugging\n./bin/run validate ./path/to/asyncapi.yml\n\n# With verbose output\nDEBUG=* ./bin/run validate ./path/to/asyncapi.yml\n```\n\n### Method 2: Using Node.js Inspector\n\n```bash\n# Start with Node inspector\nnode --inspect-brk ./bin/run validate ./path/to/asyncapi.yml\n\n# Then open Chrome DevTools at: chrome://inspect\n```\n\n### Method 3: VS Code Debugging\n\nCreate `.vscode/launch.json`:\n\n```json\n{\n \"version\": \"0.2.0\",\n \"configurations\": [\n {\n \"type\": \"node\",\n \"request\": \"launch\",\n \"name\": \"Debug CLI Command\",\n \"program\": \"${workspaceFolder}/bin/run\",\n \"args\": [\"validate\", \"./test/fixtures/specification.yml\"],\n \"env\": {\n \"NODE_ENV\": \"development\",\n \"TEST\": \"1\"\n },\n \"sourceMaps\": true,\n \"outFiles\": [\"${workspaceFolder}/lib/**/*.js\"]\n },\n {\n \"type\": \"node\",\n \"request\": \"launch\",\n \"name\": \"Debug Current Test File\",\n \"program\": \"${workspaceFolder}/node_modules/mocha/bin/_mocha\",\n \"args\": [\n \"--require\", \"ts-node/register\",\n \"--require\", \"tsconfig-paths/register\",\n \"--timeout\", \"100000\",\n \"${file}\"\n ],\n \"env\": {\n \"NODE_ENV\": \"development\",\n \"TEST\": \"1\",\n \"CUSTOM_CONTEXT_FILENAME\": \"test.asyncapi-cli\"\n },\n \"sourceMaps\": true\n }\n ]\n}\n```\n\n### Method 4: Adding Console Logs\n\nFor quick debugging, add logs in command files:\n\n```typescript\n// In src/apps/cli/commands/validate.ts\nasync run() {\n const { args, flags } = await this.parse(Validate);\n \n // Debug: Log parsed arguments\n console.log('DEBUG - Args:', JSON.stringify(args, null, 2));\n console.log('DEBUG - Flags:', JSON.stringify(flags, null, 2));\n \n // ... rest of the command\n}\n```\n\n---\n\n## Debugging the API Server\n\n### Starting the API in Development Mode\n\n```bash\n# Start with hot-reload\nnpm run api:dev\n\n# Or manually with debugging\nNODE_ENV=development DEBUG=* node ./lib/apps/api/server.js\n```\n\n### Testing API Endpoints\n\n```bash\n# Validate endpoint\ncurl -X POST http://localhost:3000/v1/validate \\\n -H \"Content-Type: application/json\" \\\n -d '{\"asyncapi\": \"asyncapi: 3.1.0\\ninfo:\\n title: Test\\n version: 1.0.0\\nchannels: {}\"}'\n\n# Parse endpoint\ncurl -X POST http://localhost:3000/v1/parse \\\n -H \"Content-Type: application/json\" \\\n -d '{\"asyncapi\": \"...\"}'\n```\n\n### Debugging API Controllers\n\nAdd middleware logging:\n\n```typescript\n// In src/apps/api/middlewares/logger.middleware.ts\n// Logs are automatically enabled in development mode\n```\n\n---\n\n## Debugging Services\n\n### ValidationService\n\nThe `ValidationService` handles document validation. To debug:\n\n```typescript\n// Test the service directly\nimport { ValidationService } from '@services/validation.service';\nimport { load } from '@models/SpecificationFile';\n\nasync function debugValidation() {\n const service = new ValidationService();\n const specFile = await load('./path/to/spec.yml');\n \n const result = await service.validateDocument(specFile, {\n 'fail-severity': 'error',\n 'log-diagnostics': true,\n });\n \n console.log('Validation Result:', JSON.stringify(result, null, 2));\n}\n```\n\n### ConversionService\n\n```typescript\nimport { ConversionService } from '@services/convert.service';\nimport { load } from '@models/SpecificationFile';\n\nasync function debugConversion() {\n const service = new ConversionService();\n const specFile = await load('./path/to/spec.yml');\n \n const result = await service.convertDocument(specFile, {\n format: 'asyncapi',\n 'target-version': '3.0.0',\n perspective: 'server',\n });\n \n console.log('Conversion Result:', JSON.stringify(result, null, 2));\n}\n```\n\n### GeneratorService\n\n```typescript\nimport { GeneratorService } from '@services/generator.service';\n\nasync function debugGenerator() {\n const service = new GeneratorService();\n // Add your debugging logic\n}\n```\n\n---\n\n## Writing Tests\n\n### Test File Naming Convention\n\n- Unit tests: `test/unit//.test.ts`\n- Integration tests: `test/integration/.test.ts`\n\n### Unit Test Structure\n\n```typescript\n// test/unit/services/my-service.test.ts\nimport { expect } from 'chai';\nimport { MyService } from '../../../src/domains/services/my.service';\n\ndescribe('MyService', () => {\n let service: MyService;\n\n beforeEach(() => {\n service = new MyService();\n });\n\n describe('methodName', () => {\n it('should do something when given valid input', async () => {\n // Arrange\n const input = { /* test data */ };\n \n // Act\n const result = await service.methodName(input);\n \n // Assert\n expect(result.success).to.be.true;\n expect(result.data).to.exist;\n });\n\n it('should handle errors gracefully', async () => {\n // Arrange\n const invalidInput = null;\n \n // Act\n const result = await service.methodName(invalidInput);\n \n // Assert\n expect(result.success).to.be.false;\n expect(result.error).to.include('error message');\n });\n });\n});\n```\n\n### Integration Test Structure (CLI Commands)\n\n```typescript\n// test/integration/mycommand.test.ts\nimport { expect, test } from '@oclif/test';\nimport path from 'path';\n\nconst validSpec = path.resolve(__dirname, '../fixtures/specification.yml');\nconst invalidSpec = path.resolve(__dirname, '../fixtures/specification-invalid.yml');\n\ndescribe('mycommand', () => {\n describe('with valid input', () => {\n test\n .stdout()\n .command(['mycommand', validSpec])\n .it('should succeed with valid specification', (ctx) => {\n expect(ctx.stdout).to.contain('Success');\n });\n });\n\n describe('with invalid input', () => {\n test\n .stderr()\n .command(['mycommand', invalidSpec])\n .exit(1)\n .it('should fail with invalid specification', (ctx) => {\n expect(ctx.stderr).to.contain('Error');\n });\n });\n\n describe('with flags', () => {\n test\n .stdout()\n .command(['mycommand', validSpec, '--output', 'result.json'])\n .it('should handle output flag', (ctx) => {\n expect(ctx.stdout).to.contain('saved');\n });\n });\n});\n```\n\n### API Controller Test Structure\n\n```typescript\n// test/unit/controllers/my.controller.test.ts\nimport request from 'supertest';\nimport { App } from '../../../src/apps/api/app';\nimport { MyController } from '../../../src/apps/api/controllers/my.controller';\n\ndescribe('MyController', () => {\n let app: App;\n\n beforeEach(async () => {\n app = new App([new MyController()]);\n await app.init();\n });\n\n describe('[POST] /v1/myendpoint', () => {\n it('should return 200 with valid input', async () => {\n return request(app.getServer())\n .post('/v1/myendpoint')\n .send({ data: 'valid' })\n .expect(200)\n .then((response) => {\n expect(response.body).to.have.property('result');\n });\n });\n\n it('should return 422 with invalid input', async () => {\n return request(app.getServer())\n .post('/v1/myendpoint')\n .send({})\n .expect(422);\n });\n });\n});\n```\n\n### Using Test Fixtures\n\n```typescript\nimport path from 'path';\nimport { load } from '@models/SpecificationFile';\n\n// Load test fixtures\nconst fixturesPath = path.resolve(__dirname, '../../fixtures');\n\nasync function loadTestSpec(filename: string) {\n return load(path.join(fixturesPath, filename));\n}\n\n// Usage in tests\ndescribe('MyTest', () => {\n it('should handle v3 spec', async () => {\n const spec = await loadTestSpec('specification-v3.yml');\n // ... test logic\n });\n});\n```\n\n---\n\n## Running Tests\n\n### Run All Tests\n\n```bash\nnpm test\n```\n\n### Run Only CLI Tests\n\n```bash\nnpm run cli:test\n```\n\n### Run Only Unit Tests\n\n```bash\nnpm run unit:test\n```\n\n### Run a Single Test File\n\n```bash\nnpm run test:one -- test/integration/validate.test.ts\n```\n\n### Run Tests with Coverage\n\n```bash\nnpm run cli:test\n# Coverage report is generated in ./coverage/\n```\n\n### Run Tests in Watch Mode (Development)\n\n```bash\n# Using nodemon for file watching\nnpm run dev\n\n# Then run tests manually when needed\nnpm run unit:test\n```\n\n---\n\n## Common Issues & Solutions\n\n### Issue 1: \"Cannot find module '@utils/proxy'\"\n\n**Cause:** TypeScript path aliases not resolved.\n\n**Solution:**\n```bash\n# Rebuild the project\nnpm run build\n```\n\n### Issue 2: Permission Denied Errors\n\n**Cause:** Files created by root or different user.\n\n**Solution:**\n```bash\n# Fix permissions\nsudo chown -R $(whoami) ./lib ./node_modules ./.nyc_output\n```\n\n### Issue 3: Test Context File Conflicts\n\n**Cause:** Tests using the same context file as development.\n\n**Solution:**\n```bash\n# Set test-specific context file\nexport CUSTOM_CONTEXT_FILENAME=\"test.asyncapi-cli\"\nexport CUSTOM_CONTEXT_FILE_LOCATION=\"\"\n```\n\n### Issue 4: \"ECONNREFUSED\" in API Tests\n\n**Cause:** API server not started or wrong port.\n\n**Solution:**\n```bash\n# Ensure the app is initialized in tests\nconst app = new App([new MyController()]);\nawait app.init(); // Don't forget this!\n```\n\n### Issue 5: Async Test Timeouts\n\n**Cause:** Default timeout too short for async operations.\n\n**Solution:**\n```typescript\n// Increase timeout for specific tests\nit('should handle slow operation', async function() {\n this.timeout(30000); // 30 seconds\n // ... test logic\n});\n```\n\n### Issue 6: ESLint Errors in Tests\n\n**Cause:** Using testing patterns that trigger lint rules.\n\n**Solution:**\n```typescript\n// Add eslint disable for specific patterns\n/* eslint-disable @typescript-eslint/no-unused-expressions */\nexpect(result).to.be.true; // Chai assertions\n```\n\n---\n\n## Debugging Tools & Tips\n\n### 1. Enable Verbose Logging\n\n```bash\nDEBUG=* ./bin/run validate spec.yml\n```\n\n### 2. Use Node.js Inspector\n\n```bash\nnode --inspect-brk ./bin/run validate spec.yml\n# Open chrome://inspect in Chrome\n```\n\n### 3. Print Stack Traces\n\n```typescript\ntry {\n // risky operation\n} catch (error) {\n console.error('Stack trace:', error.stack);\n throw error;\n}\n```\n\n### 4. Use TypeScript Source Maps\n\nEnsure `tsconfig.json` has:\n```json\n{\n \"compilerOptions\": {\n \"sourceMap\": true\n }\n}\n```\n\n### 5. Debug Parser Output\n\n```typescript\nimport { Parser } from '@asyncapi/parser';\n\nconst parser = new Parser();\nconst { document, diagnostics } = await parser.parse(specContent);\n\nconsole.log('Parsed document:', JSON.stringify(document?.json(), null, 2));\nconsole.log('Diagnostics:', JSON.stringify(diagnostics, null, 2));\n```\n\n### 6. Inspect Service Results\n\nAll services return a `ServiceResult` type:\n```typescript\ninterface ServiceResult {\n success: boolean;\n data?: T;\n error?: string;\n}\n\n// Always check both success and data\nif (result.success && result.data) {\n console.log('Success:', result.data);\n} else {\n console.log('Error:', result.error);\n}\n```\n\n### 7. Test Commands Interactively\n\n```bash\n# Build and run immediately\nnpm run build && ./bin/run validate ./test/fixtures/specification.yml\n```\n\n---\n\n## Quick Reference\n\n| Task | Command |\n|------|---------|\n| Build project | `npm run build` |\n| Run all tests | `npm test` |\n| Run CLI tests | `npm run cli:test` |\n| Run unit tests | `npm run unit:test` |\n| Run single test | `npm run test:one -- ` |\n| Lint code | `npm run lint` |\n| Fix lint issues | `npm run lint:fix` |\n| Start API dev server | `npm run api:dev` |\n| Debug CLI command | `./bin/run ` |\n| Debug with inspector | `node --inspect-brk ./bin/run ` |\n\n---\n\n## Getting Help\n\nIf you're still stuck:\n\n1. Check existing tests for similar functionality\n2. Look at the error messages and stack traces\n3. Search for similar issues in the [GitHub Issues](https://github.com/asyncapi/cli/issues)\n4. Ask in the [AsyncAPI Slack](https://asyncapi.com/slack-invite) `#tooling` channel\n\n" }, { "path": "docs/github-action.md", "content": "---\ntitle: GitHub Action for CLI\nweight: 50\n---\n\nThis action exposes the [AsyncAPI CLI](https://github.com/asyncapi/cli). It allows you to generate documentation, validate AsyncAPI documents, convert between different AsyncAPI versions and much more. The source code of the action can be found [here](https://github.com/asyncapi/cli/tree/master/github-action)\n\n## Inputs\n\n### `cli_version`\n\nVersion of the AsyncAPI CLI you wish to use. You can find all available versions [here](https://github.com/asyncapi/cli/releases). Recommended leave it out of the inputs and use the default value.\n\n**Default** points to the`latest` version.\n\n> [!TIP]\n> We recommend to default to `latest` version. This way there is no overhead with the script updating the CLI version. As it takes a lot of time to update the CLI version, we recommend to update it only when you need to use another one for compatibility reasons.\n\n### `command`\n\nCommand that you wish to run. You can find all available commands Available commands are:\n- `generate` - generates documentation from AsyncAPI document\n- `validate` - validates AsyncAPI document\n- `optimize` - optimizes AsyncAPI document\n- `convert` - converts AsyncAPI document to another version\n- `custom` - allows you to run any command that is available in the AsyncAPI CLI. You can find all available commands [here](https://www.asyncapi.com/docs/tools/cli/usage).\n\n**Default** points to `generate` command.\n\n> [!IMPORTANT]\n> In case you want to use `custom` command, you need to pass an array of commands to the [`custom_command`](#custom_command) input. Although passing command is not required, it is recommended to pass it to avoid any issues later on.\n> For example, if you want to run `asyncapi bundle ./asyncapi.yaml --output final-asyncapi.yaml` you need to pass `\"bundle ./asyncapi.yaml --output final-asyncapi.yaml\" to the `custom_command` input.\n\n### `custom_command`\n\nIn case you want to use `custom` command you need to pass the command that you want to run in this input. You can find all available commands [here](https://www.asyncapi.com/docs/tools/cli/usage). \n\n**Default** points to '' (empty string).\n\nSample usage:\n\n```yaml\n- name: Generating HTML from my AsyncAPI document\n uses: asyncapi/cli@v2.16.0# You can use any version you want\n with:\n custom_command: bundle ./asyncapi.yaml --output final-asyncapi.yaml\n```\n\n> [!CAUTION]\n> You have to pass the whole command as a string including the parameters and the command itself.\n> It will run like this: `asyncapi `\n\n\n### `filepath`\n\nPath to the AsyncAPI document that you want to process. \n\n**Default** expects the AsyncAPI document to be in the root of the repository and named `asyncapi.yaml`.\n\n### `template`\n\nTemplate 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.\n\n**Default** points to `@asyncapi/markdown-template@2.0.0` template.\n\n> [!TIP]\n> 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.\n\n### `language`\n\nSpecifies the language to be used for the generated models. The value must be a valid language name supported by [modelina](https://github.com/asyncapi/modelina). \n\n**Default** is not set.\n\n> [!WARNING]\n> Either `language` or `template` must be set else an error will be thrown. \n> The action will return an error if the language is not supported by [modelina](https://github.com/asyncapi/modelina).\n\n### `output`\n\nPath to the output directory. Can be used for `generate` and `convert` commands.\n\n**Default** points to `output` directory in the root of the repository.\n\n### `parameters`\n\nThe command that you use might support and even require specific parameters to be passed to the CLI for the generation. You can find all available parameters [here](https://www.asyncapi.com/docs/tools/cli/usage).\n\n**Default** points to '' (empty string).\n\n> [!NOTE]\n> For template parameters, you need to pass them as `-p ` as can be seen in CLI documentation.\n\n\n## Example usage\n\n> [!WARNING]\n> Using `docker://asyncapi/github-action-for-cli` will not work as expected. This is because the GitHub Actions runner does not pass params to the docker image correctly. This is why we recommend to use `asyncapi/cli` instead.\n> However, you don't need to worry as it won't build the image every time. It will pull it from Docker Hub as it is already built there.\n\n### Basic\n\nIn case all defaults are fine for you, just add such step:\n\n```yaml\n- name: Generating Markdown from my AsyncAPI document\n uses: asyncapi/cli@v2.16.0 # You can use any version you want\n```\n\n### Using all possible inputs\n\nIn case you do not want to use defaults, you for example want to use different template:\n\n```yaml\n- name: Generating HTML from my AsyncAPI document\n uses: asyncapi/cli@v2.16.0 # You can use any version you want\n with:\n command: generate\n filepath: ./docs/api/asyncapi.yaml\n template: \"@asyncapi/html-template@0.9.0\" #In case of template from npm. Or can use a link.\n output: ./generated-html\n parameters: \"-p baseHref=/test-experiment/ sidebarOrganization=byTags\"\n```\n> [!IMPORTANT]\n> Note the usage of `-p` in `parameters` input. This is required for template parameters, unlike previous versions of this action as the action includes other commands than just `generate`.\n\n### Example workflow with publishing generated HTML to GitHub Pages\n\nIn 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:\n\n```yaml\nname: AsyncAPI documents processing\n\non:\n push:\n branches: [ master ]\n\njobs:\n generate:\n runs-on: ubuntu-latest\n steps:\n #\"standard step\" where repo needs to be checked-out first\n - name: Checkout repo\n uses: actions/checkout@v2\n \n #In case you do not want to use defaults, you for example want to use different template\n - name: Generating HTML from my AsyncAPI document\n uses: asyncapi/cli@v2.16.0 # You can use any version you want\n with:\n template: '@asyncapi/html-template@0.9.0' #In case of template from npm, because of @ it must be in quotes\n filepath: docs/api/my-asyncapi.yml\n parameters: -p baseHref=/test-experiment/ sidebarOrganization=byTags #space separated list of key/values\n output: generated-html\n \n #Using another action that takes generated HTML and pushes it to GH Pages\n - name: Deploy GH page\n uses: JamesIves/github-pages-deploy-action@3.4.2\n with:\n ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n BRANCH: gh-pages\n FOLDER: generated-html\n```\n\n### Example workflow for generating models\n\nIn case you want to use models generated from your AsyncAPI document, you can use this action to generate them and then use them in your workflow. This is how full workflow could look like:\n\n```yaml\n\nname: AsyncAPI documents processing\n\non:\n push:\n branches: [ master ]\n\njobs:\n generate-models:\n runs-on: ubuntu-latest\n steps:\n #\"standard step\" where repo needs to be checked-out first\n - name: Checkout repo\n uses: actions/checkout@v2\n \n - name: Generating models from my AsyncAPI document\n uses: asyncapi/cli@v2.16.0 # You can use any version you want\n with:\n command: generate\n filepath: docs/api/my-asyncapi.yml\n language: typescript\n output: generated-models\n```\n\n### Example workflow for validating AsyncAPI document changes\n\nIn case you want to validate your AsyncAPI document changes, you can use this action to validate them and then use them in your workflow. This is how full workflow could look like:\n\n```yaml\nname: Validate AsyncAPI document\n\non:\n pull_request:\n branches: [ master ]\n\njobs:\n validate:\n runs-on: ubuntu-latest\n steps:\n #\"standard step\" where repo needs to be checked-out first\n - name: Checkout repo\n uses: actions/checkout@v2\n \n - name: Validating AsyncAPI document\n uses: asyncapi/cli@v2.16.0 # You can use any version you want\n with:\n command: validate\n filepath: docs/api/my-asyncapi.yml\n```\n\n## Local dry run\n\nUse following commands to run and test github action locally:\n\n1. Build docker image of github action for cli\n\n ```bash\n npm run action:docker:build\n ```\n\n2. Execute docker image with proper arguments\n\n ```bash\n docker run -e GITHUB_WORKSPACE=\"\" --workdir /action -v \"/home/{user}/path/to/repo\":\"/action\" asyncapi/github-action-for-cli \"\" \"generate\" \"github-action/test/asyncapi.yml\" \"@asyncapi/markdown-template@2.0.0\" \"\" \"output\" \"\" \"\"\n ```\n\nMake sure to change the path of the repo and user in the command.\n\n## Troubleshooting\n\nYou 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." }, { "path": "docs/index.md", "content": "---\ntitle: 'Introduction'\nweight: 20\n---\n\n\nThe AsyncAPI CLI is a command-line tool that provides a set of commands for working with AsyncAPI documents. AsyncAPI is a specification for describing asynchronous APIs, which allows developers to define the structure of messages exchanged between different parts of their applications. The AsyncAPI CLI simplifies creating, validating, bundling, and manipulating AsyncAPI documents, making it easier to work with asynchronous APIs.\n\n## Features\n\nThe AsyncAPI CLI offers the following key features:\n\n* Creation: New AsyncAPI documents can be created from scratch using the CLI, which is useful when starting a new project or creating a new version of an existing API.\n\n* Validation: AsyncAPI documents can be quickly and easily validated using the [AsyncAPI Parser](https://github.com/asyncapi/parser-js), which ensures that the documents conform to the AsyncAPI specification and catches errors early in the development process.\n\n* Conversion: The AsyncAPI CLI can convert AsyncAPI documents from one version to another, which is helpful for migrating APIs to a newer version of the AsyncAPI specification.\n\n* Difference: The AsyncAPI CLI can be used to find the differences between two AsyncAPI documents, which helps compare different versions of an API or identify changes made to an API.\n \n* Generation: The AsyncAPI CLI leverages AsyncAPI libraries like [Generator](https://github.com/asyncapi/generator) and [Modelina](https://github.com/asyncapi/modelina), which allow you to generate various types of documentation, applications, and models in different programming languages. This feature can save significant time and effort when creating new APIs.\n\n* Optimize: Using [Optimizer](https://github.com/asyncapi/optimizer/), the AsyncAPI CLI can be used to optimize an AsyncAPI specification file which can optimize the structure of the AsyncAPI document to make it smaller and without repetition.\n\n* Start: The AsyncAPI CLI can be used to start [AsyncAPI Studio](https://studio.asyncapi.com/) locally, which the user can use to view, edit, and test AsyncAPI documents.\n \nTo summarize, the AsyncAPI CLI offers the following features and process flow, as shown in the diagram below:\n\n```mermaid\ngraph TD;\nA[AsyncAPI Document]\nB[Creation]\nJ[Studio - Editor]\nI[Optimization]\nD[Validation]\nC[Generation]\nF[Apps/Docs]\nG[Models]\nH[Diff]\nK[Bundling]\nE[Conversion]\nA-->B;\nA-->D;\nA-->C;\nC-->F\nC-->G\nA-->H;\nA-->I;\nA-->J;\nA-->E;\nA-->K;\n```\n\n## CLI flow\n\nThe following flowchart illustrates the process flow of the AsyncAPI CLI:\n\n```mermaid\ngraph TD;\nA[Start] --> B[User runs the AsyncAPI CLI]\nB --> C[User issues a command]\nC --> D[CLI processes the command and runs the corresponding operation]\nD --> |Is the operation successful?| E{Yes}\nD --> |Is the operation recoverable?| F{Yes}\nE --> G[CLI returns the results of the operation to the user]\nF --> |Operation Error| H[CLI displays an error message and suggests possible next steps]\nG --> J[User receives the results]\nH --> I[User follows suggested steps to recover]\nI --> C[User reissues the corrected command]\nJ[User terminates the AsyncAPI CLI] --> K[End]\n```\n\nThis flowchart shows the high-level process that occurs when using the AsyncAPI CLI. The user starts by running a command (such as `validate`, `generate`, or `start`), which the CLI processes. The CLI then performs the corresponding operation (such as validating or generating an AsyncAPI document) and returns the results to the user. If an error occurs, the CLI displays an error message and suggests possible next steps for the user.\n" }, { "path": "docs/installation.md", "content": "---\ntitle: 'Installation guide'\nweight: 20\n---\n\n## Node and npm\n\nTo use the AsyncAPI CLI tool, you must install NPM and Node.js version 16 or higher. To check if you already have both installed, run the following commands in your terminal:\n\n```sh\n# check if node is installed\nnode -v\n# or\nnode --version\n\n# check if NPM is installed\nnpm -v\n# or\nnpm --version\n```\n\nIf you don’t have Node.js or NPM installed, you can install both with this [Node.js package manager](https://nodejs.org/en/download/package-manager/).\n\nAfter installing Node.js and NPM, run the following command to install the AsyncAPI ClI globally:\n```sh\nnpm install -g @asyncapi/cli\n```\nTo enable the autocomplete feature in the CLI for the shells **bash and zshrc**, there is a script that will run automatically and autocomplete is only support for **bash and zshrc** for the **powershell** refer to manually enabling [autocomplete](https://www.asyncapi.com/docs/tools/cli/autocompleteEnabled) guide in ClI:\n\nAfter the ClI installation :\n\nif the configuration is not present logs will be:\n```sh\n✅ Autocomplete configuration added to .zshrc.\n```\nIf the configuration is present for autocomplete logs:\n```sh\n✅ Autocomplete is already configured. Skipping addition.\n```\n\nTo refresh the variables:\n\n```sh\n source ~/.bashrc # For bash\n source ~/.zshrc # For zsh\n```\n\n## Docker\n\nInstall [Docker](https://docs.docker.com/get-docker/) first, then use docker to build the image using the following command :\n``` \ndocker build -t asyncapi/cli:latest . \n``` \nand run the image using the following command :\n\n```bash\ndocker run --rm -it \\\n--user=root \\\n-v [ASYNCAPI SPEC FILE LOCATION]:/app/asyncapi.yml \\\n-v [GENERATED FILES LOCATION]:/app/output \\\nasyncapi/cli [COMMAND HERE]\n\n# Example that you can run inside the cli directory after cloning this repository. First, you specify the mount in the location of your AsyncAPI specification file and then you mount it in the directory where the generation result should be saved.\ndocker run --rm -it \\\n --user=root \\\n -v ${PWD}/test/integration/fixtures/asyncapi_v1.yml:/app/asyncapi.yml \\\n -v ${PWD}/output:/app/output \\\n asyncapi/cli generate fromTemplate -o /app/output /app/asyncapi.yml @asyncapi/html-template --force-write\n```\nNote: Use ``` ` ``` instead of `\\` for Windows.\n\n\n## Mac\nThere are two ways to install the AsyncAPI CLI on your macOS: using the `brew` package manager or `pkg` files.\n\n### brew\n\nTo install the AsyncAPI CLI using the `brew` package manager, run the following commands in your terminal:\n```sh\n# Install brew\n/bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)\"\n\n# Install AsyncAPI CLI\nbrew install asyncapi\n```\n\n### pkg\n\nEvery release of the AsyncAPI CLI has two macOS dedicated `pkg` file that enables you to install the CLI tool as a macOS application for x64 as well as arm64 architecture.\nTo download the latest CLI release, run this command in your terminal:\n```sh\n# For x64\ncurl -OL https://github.com/asyncapi/cli/releases/latest/download/asyncapi.x64.pkg\n\n# For arm64\ncurl -OL https://github.com/asyncapi/cli/releases/latest/download/asyncapi.arm64.pkg\n```\n\nTo download a specific CLI release, run this command in your terminal:\n```sh\ncurl -OL https://github.com/asyncapi/cli/releases/download//asyncapi.pkg\n```\n\n\nFollow this link for all AsyncAPI CLI releases.\n\n\nAfter downloading the AsyncAPI CLI, install it via the following command:\n\n```sh\nsudo installer -pkg asyncapi.pkg -target /\n```\n\n## Windows \n\nThere are two ways to install the AsyncAPI CLI on your Windows operating system: using the `chocolatey` package manager or executable files.\n\n### Chocolatey\n\nPrerequisites:\n[Chocolatey](https://chocolatey.org/install) must be installed on your Windows operating system. The installation instructions can be found [here](https://docs.chocolatey.org/en-us/choco/setup#installing-chocolatey-cli).\n\nTo install the AsyncAPI CLI using the `chocolatey` package manager, run the following command in your terminal with administrator privileges:\n\n```sh\n# Install AsyncAPI CLI\nchoco install asyncapi\n```\n\nTo upgrade run this command:- \n```sh\n# Upgrade AsyncAPI CLI\nchoco upgrade asyncapi\n```\nTo install a specific version run this command:\n```sh\n# Install AsyncAPI CLI version xx.xx.xx\nchoco install asyncapi --version xx.xx.xx\n```\nAll the AsyncAPI CLI versions can be found [here](https://chocolatey.org/packages/asyncapi).\n\n### Executable files\n\nJust install the appropriate installer and simply follow the default installation steps to complete the installation process.\n\nDownload [asyncapi.x64.exe](https://github.com/asyncapi/cli/releases/latest/download/asyncapi.x64.exe) for 64-bit Windows and download [asyncapi.x86.exe](https://github.com/asyncapi/cli/releases/latest/download/asyncapi.x86.exe) for 32-bit Windows.\n\n\n## Linux\nSelecting the appropriate AsyncAPI CLI installation method on a Linux operating system depends on your Linux distro.\n\n### Debian based distros\n\nFor Debian based distros, you can install the AsycAPI CLI using the `dpkg` package manager for Debian.\n```sh\ncurl -OL https://github.com/asyncapi/cli/releases/latest/download/asyncapi.deb\n```\n\nTo download a specific release of the CLI, run this command in your terminal:\n```sh\ncurl -OL https://github.com/asyncapi/cli/releases/download//asyncapi.deb\n```\n\n### Other distros\nYou can install the AsyncAPI CLI for other Linux distros using the archive `tar.gz` file. \n\n#### For Alpine Linux / musl-based systems:\nTo download the latest Alpine-compatible release, run this command in your terminal:\n```sh\ncurl -OL https://github.com/asyncapi/cli/releases/latest/download/asyncapi-alpine.tar.gz\n```\n\nTo download a specific Alpine-compatible release, run this command in your terminal:\n```sh\ncurl -OL https://github.com/asyncapi/cli/releases/download//asyncapi-alpine.tar.gz\n```\n\nOnce downloaded, untar the file:\n```sh\ntar -xzf asyncapi-alpine.tar.gz\n```\n\n#### For other Linux distributions (glibc-based):\n\nTo download the latest release of the CLI, run this command in your terminal:\n```sh\ncurl -OL https://github.com/asyncapi/cli/releases/latest/download/asyncapi.tar.gz\n```\n\nTo download a specific release of the CLI, run this command in your terminal:\n```sh\ncurl -OL https://github.com/asyncapi/cli/releases/download//asyncapi.tar.gz\n```\n\nOnce you have downloaded the archived file, untar it by running this command in your terminal:\n```sh\ntar -xzf asyncapi.tar.gz\n```\n\n### Setting up the symlink (for both Alpine and glibc versions):\n\nThe step above will create an `AsyncAPI` directory in the current path. To run the CLI from anywhere, you must create a `symlink`. If the current path you are on is `/user/local/bin`, for example, you must create the `symlink` in the `/user/local/bin` directory by following these steps:\n```sh\n# cd into the unarchived directory\ncd asyncapi\n\n# get the absolute path\npwd\n\n# Create a symlink\nln -s /bin/asyncapi /user/local/bin/asyncapi\n\n# The \"asyncapi\" command should be available to be used\nasyncapi\n```\n> [!NOTE]\n> If youare using Alpine Linux or any musl-based distribution, make sure to download the `-alpine.tar.gz` version to avoid glibc compatibility issues. The regular `asyncapi.tar.gz` file is compiled for glibc-based systems and will not work on Alpine." }, { "path": "docs/metrics_collection.md", "content": "---\ntitle: 'Metrics Collection'\nweight: 70\n---\n\n# Metrics collection guideline\n\nAsyncAPI **anonymously** tracks command executions to improve the specification and tools, ensuring no sensitive data reaches our servers. It aids in comprehending how AsyncAPI tools are used and adopted, facilitating ongoing improvements to our specifications and tools.\n\nEven though metrics collection is enabled by default, you can always [disable tracking](#how-to-disable-tracking) if you want to.\n\n## What we collect\nWe are collecting the following metrics:\n\n- `asyncapi_adoption.action.invoked`:\nWith this metric we are tracking the command executed on the CLI as soon as the command is invoked, so it has already been executed but not finished yet. We just want to know which commands are used, regardless they have failed or succeeded.\n\nExample of the data collected by this metric when the `validate` command has been executed:\n```\nasyncapi_adoption.action.invoked COUNTER { action: 'validate' } 1\n```\n\n- `asyncapi_adoption.action.finished`:\nThis metric tracks the command executed once it has already finished, carrying the result of the execution and some metadata based on the AsyncAPI document in place.\n\nExample for `validate` command successfully executed and finished:\n```\nasyncapi_adoption.action.finished COUNTER {\n validation_result: 'valid',\n success: true,\n asyncapi_version: '2.6.0',\n asyncapi_servers: 2,\n asyncapi_channels: 4,\n asyncapi_messages: 3,\n asyncapi_operations_send: 3,\n asyncapi_operations_receive: 1,\n asyncapi_schemas: 52,\n action: 'validate'\n } 1\n```\n\n## Where the data is stored\nWe are making use of [New Relic API](https://docs.newrelic.com/docs/apis/intro-apis/introduction-new-relic-apis/#rest-api) to send the metrics collected to _New Relic_ servers, where they are stored, and finally visualized on the AsyncAPI website.\n\nMetrics won't be collected in CI environments, or when the \"CI\" env variable is set up to \"true\".\n\nThe analytics config file will be store by default at your home directory. In case you prefer to change the file path then you should set the `ASYNCAPI_METRICS_CONFIG_PATH` env var to any specific path value when running any command. For instance:\n````\nASYNCAPI_METRICS_CONFIG_PATH=/tmp/.asyncapi-analytics asyncapi config analytics --status\n````\n\n## How to disable tracking\nTo disable tracking, please run the following command: \n`asyncapi config analytics --disable`\n\nOnce disabled, if you want to enable tracking back again then run: \n`asyncapi config analytics --enable`\n\nIn case you do not know the current status of analytics, then you can append the \"--status\" flag to be aware of it:\n`asyncapi config analytics --status`\n\nRemember that keeping this tracking enabled will help AsyncAPI community to provide better specifications and tools in the future." }, { "path": "docs/usage.md", "content": "---\ntitle: 'Usage'\nweight: 40\n---\n\n\n\nThe AsyncAPI CLI makes it easier to work with AsyncAPI documents.\n# Usage\n\n\n```sh-session\n$ npm install -g @asyncapi/cli\n$ asyncapi COMMAND\nrunning command...\n$ asyncapi (--version|--v)\n@asyncapi/cli/5.0.7 darwin-arm64 node-v24.7.0\n$ asyncapi --help [COMMAND]\nUSAGE\n $ asyncapi COMMAND\n...\n```\n\n\n# Commands\n\n\n* [`asyncapi autocomplete [SHELL]`](#asyncapi-autocomplete-shell)\n* [`asyncapi bundle`](#asyncapi-bundle)\n* [`asyncapi config`](#asyncapi-config)\n* [`asyncapi config analytics`](#asyncapi-config-analytics)\n* [`asyncapi config auth add PATTERN TOKEN`](#asyncapi-config-auth-add-pattern-token)\n* [`asyncapi config context`](#asyncapi-config-context)\n* [`asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH`](#asyncapi-config-context-add-context-name-spec-file-path)\n* [`asyncapi config context current`](#asyncapi-config-context-current)\n* [`asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH`](#asyncapi-config-context-edit-context-name-new-spec-file-path)\n* [`asyncapi config context init [CONTEXT-FILE-PATH]`](#asyncapi-config-context-init-context-file-path)\n* [`asyncapi config context list`](#asyncapi-config-context-list)\n* [`asyncapi config context remove CONTEXT-NAME`](#asyncapi-config-context-remove-context-name)\n* [`asyncapi config context use CONTEXT-NAME`](#asyncapi-config-context-use-context-name)\n* [`asyncapi config versions`](#asyncapi-config-versions)\n* [`asyncapi convert [SPEC-FILE]`](#asyncapi-convert-spec-file)\n* [`asyncapi diff OLD NEW`](#asyncapi-diff-old-new)\n* [`asyncapi format [SPEC-FILE]`](#asyncapi-format-spec-file)\n* [`asyncapi generate`](#asyncapi-generate)\n* [`asyncapi generate client LANGUAGE [ASYNCAPI]`](#asyncapi-generate-client-language-asyncapi)\n* [`asyncapi generate fromTemplate [ASYNCAPI] [TEMPLATE]`](#asyncapi-generate-fromtemplate-asyncapi-template)\n* [`asyncapi generate models LANGUAGE FILE`](#asyncapi-generate-models-language-file)\n* [`asyncapi new`](#asyncapi-new)\n* [`asyncapi new file`](#asyncapi-new-file)\n* [`asyncapi new template`](#asyncapi-new-template)\n* [`asyncapi optimize [SPEC-FILE]`](#asyncapi-optimize-spec-file)\n* [`asyncapi pretty SPEC-FILE`](#asyncapi-pretty-spec-file)\n* [`asyncapi start`](#asyncapi-start)\n* [`asyncapi start api`](#asyncapi-start-api)\n* [`asyncapi start preview SPEC-FILE`](#asyncapi-start-preview-spec-file)\n* [`asyncapi start studio [SPEC-FILE]`](#asyncapi-start-studio-spec-file)\n* [`asyncapi validate [SPEC-FILE]`](#asyncapi-validate-spec-file)\n\n## `asyncapi autocomplete [SHELL]`\n\nDisplay autocomplete installation instructions.\n\n```\nUSAGE\n $ asyncapi autocomplete [SHELL] [-r]\n\nARGUMENTS\n [SHELL] (zsh|bash|powershell) Shell type\n\nFLAGS\n -r, --refresh-cache Refresh cache (ignores displaying instructions)\n\nDESCRIPTION\n Display autocomplete installation instructions.\n\nEXAMPLES\n $ asyncapi autocomplete\n\n $ asyncapi autocomplete bash\n\n $ asyncapi autocomplete zsh\n\n $ asyncapi autocomplete powershell\n\n $ asyncapi autocomplete --refresh-cache\n```\n\n_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.40/src/commands/autocomplete/index.ts)_\n\n## `asyncapi bundle`\n\nBundle one or multiple AsyncAPI Documents and their references together.\n\n```\nUSAGE\n $ asyncapi bundle [-h] [-o ] [-b ] [-d ] [-x]\n\nFLAGS\n -b, --base= Path to the file which will act as a base. This is required when some properties need to be\n overwritten.\n -d, --baseDir= One relative/absolute path to directory relative to which paths to AsyncAPI Documents that\n should be bundled will be resolved.\n -h, --help Show CLI help.\n -o, --output= The output file name. Omitting this flag the result will be printed in the console.\n -x, --xOrigin Pass this switch to generate properties \"x-origin\" that will contain historical values of\n dereferenced \"$ref\"s.\n\nDESCRIPTION\n Bundle one or multiple AsyncAPI Documents and their references together.\n\nEXAMPLES\n $ asyncapi bundle ./asyncapi.yaml > final-asyncapi.yaml\n\n $ asyncapi bundle ./asyncapi.yaml --output final-asyncapi.yaml\n\n $ asyncapi bundle ./asyncapi.yaml ./features.yaml\n\n $ asyncapi bundle ./asyncapi.yaml ./features.yaml --base ./main.yaml\n\n $ asyncapi bundle ./asyncapi.yaml ./features.yaml --base ./main.yaml --xOrigin\n\n $ asyncapi bundle ./asyncapi.yaml -o final-asyncapi.yaml --base ../public-api/main.yaml --baseDir ./social-media/comments-service\n```\n\n_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v5.0.7/src/commands/bundle.ts)_\n\n## `asyncapi config`\n\nCLI config settings\n\n```\nUSAGE\n $ asyncapi config\n\nDESCRIPTION\n CLI config settings\n```\n\n_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v5.0.7/src/commands/config/index.ts)_\n\n## `asyncapi config analytics`\n\nEnable or disable analytics for metrics collection\n\n```\nUSAGE\n $ asyncapi config analytics [-h] [-d] [-e] [-s]\n\nFLAGS\n -d, --disable disable analytics\n -e, --enable enable analytics\n -h, --help Show CLI help.\n -s, --status show current status of analytics\n\nDESCRIPTION\n Enable or disable analytics for metrics collection\n```\n\n_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v5.0.7/src/commands/config/analytics.ts)_\n\n## `asyncapi config auth add PATTERN TOKEN`\n\nAdd an authentication config for resolving $ref files requiring HTTP Authorization.\n\n```\nUSAGE\n $ asyncapi config auth add PATTERN TOKEN [-a ] [-h ...]\n\nARGUMENTS\n PATTERN Glob pattern for matching protected URLs (e.g. github.com/org/repo/**/*.*)\n TOKEN Authentication token or environment variable reference (prefix with $, e.g. $GITHUB_TOKEN)\n\nFLAGS\n -a, --auth-type= Authentication type (default is \"Bearer\")\n -h, --header=... Additional header in key=value format; can be used multiple times\n\nDESCRIPTION\n Add an authentication config for resolving $ref files requiring HTTP Authorization.\n```\n\n_See code: [src/commands/config/auth/add.ts](https://github.com/asyncapi/cli/blob/v5.0.7/src/commands/config/auth/add.ts)_\n\n## `asyncapi config context`\n\nManage short aliases for full paths to AsyncAPI documents\n\n```\nUSAGE\n $ asyncapi config context\n\nDESCRIPTION\n Manage short aliases for full paths to AsyncAPI documents\n```\n\n_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v5.0.7/src/commands/config/context/index.ts)_\n\n## `asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH`\n\nAdd a context to the store\n\n```\nUSAGE\n $ asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH [-h] [-s]\n\nARGUMENTS\n CONTEXT-NAME context name\n SPEC-FILE-PATH file path of the spec file\n\nFLAGS\n -h, --help Show CLI help.\n -s, --set-current Set context being added as the current context\n\nDESCRIPTION\n Add a context to the store\n```\n\n_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v5.0.7/src/commands/config/context/add.ts)_\n\n## `asyncapi config context current`\n\nShows the current context that is being used\n\n```\nUSAGE\n $ asyncapi config context current [-h]\n\nFLAGS\n -h, --help Show CLI help.\n\nDESCRIPTION\n Shows the current context that is being used\n```\n\n_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v5.0.7/src/commands/config/context/current.ts)_\n\n## `asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH`\n\nEdit a context in the store\n\n```\nUSAGE\n $ asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH [-h]\n\nARGUMENTS\n CONTEXT-NAME context name\n NEW-SPEC-FILE-PATH file path of the spec file\n\nFLAGS\n -h, --help Show CLI help.\n\nDESCRIPTION\n Edit a context in the store\n```\n\n_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v5.0.7/src/commands/config/context/edit.ts)_\n\n## `asyncapi config context init [CONTEXT-FILE-PATH]`\n\nInitialize context\n\n```\nUSAGE\n $ asyncapi config context init [CONTEXT-FILE-PATH] [-h]\n\nARGUMENTS\n [CONTEXT-FILE-PATH] Specify directory in which context file should be created:\n - current directory : asyncapi config context init .(default)\n - root of current repository : asyncapi config context init ./\n - user's home directory : asyncapi config context init ~`\n\nFLAGS\n -h, --help Show CLI help.\n\nDESCRIPTION\n Initialize context\n```\n\n_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v5.0.7/src/commands/config/context/init.ts)_\n\n## `asyncapi config context list`\n\nList all the stored contexts in the store\n\n```\nUSAGE\n $ asyncapi config context list [-h]\n\nFLAGS\n -h, --help Show CLI help.\n\nDESCRIPTION\n List all the stored contexts in the store\n```\n\n_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v5.0.7/src/commands/config/context/list.ts)_\n\n## `asyncapi config context remove CONTEXT-NAME`\n\nDelete a context from the store\n\n```\nUSAGE\n $ asyncapi config context remove CONTEXT-NAME [-h]\n\nARGUMENTS\n CONTEXT-NAME Name of the context to delete\n\nFLAGS\n -h, --help Show CLI help.\n\nDESCRIPTION\n Delete a context from the store\n```\n\n_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v5.0.7/src/commands/config/context/remove.ts)_\n\n## `asyncapi config context use CONTEXT-NAME`\n\nSet a context as current\n\n```\nUSAGE\n $ asyncapi config context use CONTEXT-NAME [-h]\n\nARGUMENTS\n CONTEXT-NAME name of the saved context\n\nFLAGS\n -h, --help Show CLI help.\n\nDESCRIPTION\n Set a context as current\n```\n\n_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v5.0.7/src/commands/config/context/use.ts)_\n\n## `asyncapi config versions`\n\nShow versions of AsyncAPI tools used\n\n```\nUSAGE\n $ asyncapi config versions [-h]\n\nFLAGS\n -h, --help Show CLI help.\n\nDESCRIPTION\n Show versions of AsyncAPI tools used\n```\n\n_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v5.0.7/src/commands/config/versions.ts)_\n\n## `asyncapi convert [SPEC-FILE]`\n\nConvert asyncapi documents older to newer versions or OpenAPI documents to AsyncAPI\n\n```\nUSAGE\n $ asyncapi convert [SPEC-FILE] -f openapi|asyncapi [-h] [-o ] [-t ] [-p client|server]\n [--proxyHost ] [--proxyPort ]\n\nARGUMENTS\n [SPEC-FILE] spec path, url, or context-name\n\nFLAGS\n -f, --format=