docs: fix stringify example broken link in README (#1055) #1
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 a package.json file in the root of the project | |
| name: Release - if Node project | |
| on: | |
| push: | |
| branches: | |
| - master | |
| # The below lines are not enough to have release supported for these branches | |
| - next-spec | |
| - next-major | |
| - next-major-spec | |
| - beta | |
| - alpha | |
| - next | |
| jobs: | |
| test-nodejs: | |
| # We just check the message of the first commit as there is always just one commit because we squash into one before merging | |
| # "commits" contains an array of objects where one of the properties is the commit "message" | |
| # Release workflow will be skipped if release conventional commits are not used | |
| if: | | |
| startsWith( github.repository, 'asyncapi/' ) | |
| name: Test NodeJS release on ${{ matrix.os }} | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| # Using macos-13 instead of latest (macos-14) due to an issue with Puppeteer and such runner. | |
| # See: https://github.com/puppeteer/puppeteer/issues/12327 and https://github.com/asyncapi/parser-js/issues/1001 | |
| os: [ubuntu-latest, macos-13, windows-latest] | |
| steps: | |
| - name: Set git to use LF # To once and for all finish the never-ending fight between Unix and Windows | |
| run: | | |
| git config --global core.autocrlf false | |
| git config --global core.eol lf | |
| shell: bash | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Check if Node.js project and has package.json | |
| id: packagejson | |
| run: test -e ./package.json && echo "exists=true" >> $GITHUB_OUTPUT || echo "exists=false" >> $GITHUB_OUTPUT | |
| shell: bash | |
| - if: steps.packagejson.outputs.exists == 'true' | |
| name: Check package-lock version | |
| uses: asyncapi/.github/.github/actions/get-node-version-from-package-lock@master | |
| id: lockversion | |
| - if: steps.packagejson.outputs.exists == 'true' | |
| name: Setup Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: "${{ steps.lockversion.outputs.version }}" | |
| - if: steps.lockversion.outputs.version == '18' && matrix.os == 'windows-latest' | |
| name: Install npm cli 8 | |
| shell: bash | |
| # npm cli 10 is buggy because of some cache issues | |
| run: npm install -g [email protected] | |
| - if: steps.packagejson.outputs.exists == 'true' | |
| name: Install dependencies | |
| shell: bash | |
| run: npm ci | |
| - if: steps.packagejson.outputs.exists == 'true' | |
| name: Run test | |
| run: npm test --if-present | |
| - if: failure() # Only, on failure, send a message on the 94_bot-failing-ci slack channel | |
| name: Report workflow run status to Slack | |
| uses: 8398a7/action-slack@v3 | |
| with: | |
| status: ${{ job.status }} | |
| fields: repo,action,workflow | |
| text: "Release workflow failed in testing job" | |
| env: | |
| SLACK_WEBHOOK_URL: ${{ secrets.SLACK_CI_FAIL_NOTIFY }} | |
| release: | |
| needs: [test-nodejs] | |
| name: Publish to any of NPM, GitHub, or Docker Hub | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Set git to use LF # To once and for all finish the never-ending fight between Unix and Windows | |
| run: | | |
| git config --global core.autocrlf false | |
| git config --global core.eol lf | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Check if Node.js project and has package.json | |
| id: packagejson | |
| run: test -e ./package.json && echo "exists=true" >> $GITHUB_OUTPUT || echo "exists=false" >> $GITHUB_OUTPUT | |
| shell: bash | |
| - if: steps.packagejson.outputs.exists == 'true' | |
| name: Check package-lock version | |
| uses: asyncapi/.github/.github/actions/get-node-version-from-package-lock@master | |
| id: lockversion | |
| - if: steps.packagejson.outputs.exists == 'true' | |
| name: Setup Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: "${{ steps.lockversion.outputs.version }}" | |
| - if: steps.packagejson.outputs.exists == 'true' | |
| name: Install dependencies | |
| shell: bash | |
| run: npm ci | |
| - if: steps.packagejson.outputs.exists == 'true' | |
| name: Build dependency | |
| shell: bash | |
| run: npm run build | |
| - if: steps.packagejson.outputs.exists == 'true' | |
| name: Install changelog | |
| shell: bash | |
| run: npm install @changesets/[email protected] | |
| - if: steps.packagejson.outputs.exists == 'true' | |
| name: Publish to any of NPM, Github, and Docker Hub | |
| uses: changesets/action@v1 | |
| id: release | |
| with: | |
| version: npx -p @changesets/cli changeset version | |
| commit: version packages | |
| title: "chore(release): version packages" | |
| publish: npx -p @changesets/cli changeset publish | |
| setupGitUser: false | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GH_TOKEN }} | |
| NPM_TOKEN: ${{ secrets.NPM_TOKEN }} | |
| DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }} | |
| DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }} | |
| GIT_AUTHOR_NAME: asyncapi-bot | |
| GIT_AUTHOR_EMAIL: [email protected] | |
| GIT_COMMITTER_NAME: asyncapi-bot | |
| GIT_COMMITTER_EMAIL: [email protected] | |
| - if: failure() # Only, on failure, send a message on the 94_bot-failing-ci Slack channel | |
| name: Report workflow run status to Slack | |
| uses: 8398a7/action-slack@v3 | |
| with: | |
| status: ${{ job.status }} | |
| fields: repo,action,workflow | |
| text: "Release workflow failed in release job" | |
| env: | |
| SLACK_WEBHOOK_URL: ${{ secrets.SLACK_CI_FAIL_NOTIFY }} |