docs(generator): update latest generator documentation #4740
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # It does magic only if there is package.json file in the root of the project | |
| name: PR testing - if Node project | |
| on: | |
| pull_request_target: | |
| types: [opened, reopened, synchronize, ready_for_review] | |
| push: | |
| branches: [master] | |
| jobs: | |
| test-nodejs-pr: | |
| name: Test NodeJS PR - ${{ matrix.os }} | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, macos-13, windows-latest] | |
| steps: | |
| - if: > | |
| !github.event.pull_request.draft && !( | |
| (github.actor == 'asyncapi-bot' && ( | |
| startsWith(github.event.pull_request.title, 'ci: update of files from global .github repo') || | |
| startsWith(github.event.pull_request.title, 'chore(release):') | |
| )) || | |
| (github.actor == 'asyncapi-bot-eve' && ( | |
| startsWith(github.event.pull_request.title, 'ci: update of files from global .github repo') || | |
| startsWith(github.event.pull_request.title, 'chore(release):') | |
| )) || | |
| (github.actor == 'allcontributors[bot]' && | |
| startsWith(github.event.pull_request.title, 'docs: add') | |
| ) | |
| ) | |
| id: should_run | |
| name: Should Run | |
| run: echo "shouldrun=true" >> $GITHUB_OUTPUT | |
| shell: bash | |
| - if: steps.should_run.outputs.shouldrun == 'true' | |
| name: Set git to use LF #to once and for all finish neverending fight between Unix and Windows | |
| run: | | |
| git config --global core.autocrlf false | |
| git config --global core.eol lf | |
| shell: bash | |
| - if: steps.should_run.outputs.shouldrun == 'true' | |
| name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| # Checkout the merge commit instead of the pull request head commit for a pull request | |
| # Fallback to the head commit if its not a pull request | |
| ref: ${{ github.event.pull_request.number != '' && format('refs/pull/{0}/merge', github.event.pull_request.number) || github.ref }} | |
| - if: steps.should_run.outputs.shouldrun == 'true' | |
| name: Check if Node.js project and has package.json | |
| id: packagejson | |
| run: test -e ./package.json && echo "exists=true" >> $GITHUB_OUTPUT || echo "exists=false" >> $GITHUB_OUTPUT | |
| shell: bash | |
| - if: steps.packagejson.outputs.exists == 'true' | |
| name: Check if .nvmrc exists | |
| id: nvmrc | |
| run: test -e .nvmrc && echo "exists=true" >> $GITHUB_OUTPUT || echo "exists=false" >> $GITHUB_OUTPUT | |
| shell: bash | |
| - if: steps.nvmrc.outputs.exists == 'true' | |
| name: Read Node.js version from .nvmrc | |
| id: nodeversion | |
| run: echo "version=$(cat .nvmrc)" >> $GITHUB_OUTPUT | |
| shell: bash | |
| - if: steps.packagejson.outputs.exists == 'true' && steps.nvmrc.outputs.exists == 'true' | |
| name: Setup Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: '${{ steps.nodeversion.outputs.version }}' | |
| - name: Install dependencies | |
| run: npm ci | |
| - if: steps.packagejson.outputs.exists == 'true' | |
| name: Test | |
| run: npm test --if-present | |
| - if: steps.packagejson.outputs.exists == 'true' && matrix.os == 'ubuntu-latest' | |
| name: Run linter | |
| run: npm run lint --if-present | |
| - if: steps.packagejson.outputs.exists == 'true' | |
| name: Run release assets generation to make sure PR does not break it | |
| shell: bash | |
| run: npm run generate:assets --if-present | |
| # Run the test:md script and capture output | |
| - if: ${{ steps.packagejson.outputs.exists == 'true' && matrix.os == 'ubuntu-latest' }} | |
| name: Run markdown checks | |
| id: markdown_check | |
| run: | | |
| ERRORS=$(npm run test:md | sed -n '/Errors in file/,$p') | |
| echo "markdown_output<<EOF" >> $GITHUB_OUTPUT | |
| echo "$ERRORS" >> $GITHUB_OUTPUT | |
| echo "EOF" >> $GITHUB_OUTPUT | |
| # Post a comment using sticky-pull-request-comment | |
| - name: Comment on PR with markdown issues | |
| if: ${{ steps.markdown_check.outputs.markdown_output != '' && matrix.os == 'ubuntu-latest' }} | |
| uses: marocchino/sticky-pull-request-comment@3d60a5b2dae89d44e0c6ddc69dd7536aec2071cd | |
| with: | |
| header: markdown-check-error | |
| GITHUB_TOKEN: ${{ secrets.GH_TOKEN }} | |
| message: | | |
| ### Markdown Check Results | |
| We found issues in the following markdown files: | |
| ``` | |
| ${{ steps.markdown_check.outputs.markdown_output }} | |
| ``` | |
| # Delete the comment if there are no issues | |
| - if: ${{ steps.markdown_check.outputs.markdown_output == '' && matrix.os == 'ubuntu-latest' }} | |
| name: Delete markdown check comment | |
| uses: marocchino/sticky-pull-request-comment@3d60a5b2dae89d44e0c6ddc69dd7536aec2071cd | |
| with: | |
| header: markdown-check-error | |
| delete: true | |
| GITHUB_TOKEN: ${{ secrets.GH_TOKEN }} | |
| - if: steps.packagejson.outputs.exists == 'true' | |
| name: Upload Coverage to Codecov | |
| uses: codecov/codecov-action@e28ff129e5465c2c0dcc6f003fc735cb6ae0c673 | |
| with: | |
| fail_ci_if_error: true | |
| files: ./coverage/lcov.info | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| verbose: true |