feat: add GitHub action for releasing via Changeset #1029
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| { | ||
| "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json", | ||
| "changelog": "@changesets/cli/changelog", | ||
| "commit": false, | ||
| "fixed": [], | ||
| "linked": [], | ||
| "access": "restricted", | ||
| "baseBranch": "master", | ||
| "updateInternalDependencies": "patch", | ||
| "privatePackages": { | ||
| "version": true, | ||
| "tag": true | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,141 @@ | ||||||
| # This action is centrally managed in https://github.com/asyncapi/.github/ | ||||||
| # Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in the above-mentioned repo | ||||||
|
|
||||||
| # It does magic only if there is a package.json file in the root of the project | ||||||
| name: Release with changeset | ||||||
|
|
||||||
| on: | ||||||
| push: | ||||||
| branches: | ||||||
| - master | ||||||
| # The below lines are not enough to have release supported for these branches | ||||||
| # Make sure the configuration of the `semantic-release` package mentions these branches | ||||||
|
Comment on lines
+11
to
+12
There was a problem hiding this comment. We do not use
Suggested change
|
||||||
| - next-spec | ||||||
| - next-major | ||||||
| - next-major-spec | ||||||
| - beta | ||||||
| - alpha | ||||||
| - next | ||||||
|
Comment on lines
+13
to
+18
There was a problem hiding this comment. Do we need anything else to be configured (perhaps in changeset config file?) to allow those branches to be released as well? How does it work? There was a problem hiding this comment. I found out this in their docs: https://github.com/changesets/changesets/blob/main/docs/prereleases.md It should be done manually it seems. I guess in the workflow, detecting we are not in master branch and run We can work on it in a second iteration. There was a problem hiding this comment. ok sure will do that. |
||||||
|
|
||||||
| 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/') && | ||||||
| (startsWith(github.event.commits[0].message, 'fix:') || | ||||||
| startsWith(github.event.commits[0].message, 'fix!:') || | ||||||
| startsWith(github.event.commits[0].message, 'feat:') || | ||||||
| startsWith(github.event.commits[0].message, 'feat!:')) | ||||||
| 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: Install Changesets | ||||||
| run: npm install --save-dev @changesets/[email protected] | ||||||
|
There was a problem hiding this comment. is it still needed if in the end you call below There was a problem hiding this comment. ok removed we should add this like we do for semantic release. |
||||||
|
|
||||||
| - if: steps.packagejson.outputs.exists == 'true' | ||||||
| name: Create Release Pull Request or Release | ||||||
| uses: changesets/action@v1 | ||||||
| - if: steps.packagejson.outputs.exists == 'true' | ||||||
| name: Publish to any of NPM, Github, and Docker Hub | ||||||
| id: release | ||||||
| with: | ||||||
| publish: npx turbo run build && npx changeset publish | ||||||
| version: npx changeset version | ||||||
|
Comment on lines
+120
to
+121
There was a problem hiding this comment. if you do not specify the version, npx will always pick up latest - which in future will kick maintainers big time There was a problem hiding this comment. ok now added the version. |
||||||
| commit: "version packages" | ||||||
| title: "chore: version packages" | ||||||
| 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 }} | ||||||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not centrally managed yet. Please remove the comment. We can add it once this is moved into
.githubrepoThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done.