feat: add GitHub action for releasing via Changeset #1029
Conversation
ayushnau
requested review from
magicmatatjahu,
jonaslagoni,
smoya and
asyncapi-bot-eve
as code owners
ayushnau
changed the title
ayushnau
changed the title
ayushnau
changed the title
|
@smoya please review and merge this pr. |
package.json
Outdated
| "changeset": "changeset", | ||
| "version-packages": "changeset version", | ||
| "publish-packages": "turbo run build && changeset publish" |
There was a problem hiding this comment.
instead of adding those to package.json did you consider just using npx and package directly in release config?
in past with semantic-release we resigned from using npm commands if they were not needed during regular development. So semantic-release we used directly like npx [email protected] so we had less things to maintain, it was easier to reuse across repos, and dependabot was not bugging us with new versions bump
.github/workflows/release.yml
Outdated
| # 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 - if Node project |
There was a problem hiding this comment.
| name: Release - if Node project | |
| name: Release with changeset |
can you please name file like release-with-changeset.yml as might be that this release will work also in our generator and then also other monorepos, so we will maintain it in .github and we will do it with release-with-changeset.yml name - so once you opt in in future for file from .github, it will just be overwritten
There was a problem hiding this comment.
ok sure changed the name as required.
There was a problem hiding this comment.
Minor: Actually, shouldn't be called changesets in plural? That's the name of the project. So release-with-changesets.yml? On the contrary, the config is located in a directory called .changeset so not sure 🤷 😆
There was a problem hiding this comment.
ok changed to the changesets.
| @@ -0,0 +1,141 @@ | |||
| # This action is centrally managed in https://github.com/asyncapi/.github/ | |||
There was a problem hiding this comment.
This is not centrally managed yet. Please remove the comment. We can add it once this is moved into .github repo
| # This action is centrally managed in https://github.com/asyncapi/.github/ |
| 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 npx ?
There was a problem hiding this comment.
ok removed we should add this like we do for semantic release.
| publish: npx turbo run build && npx changeset publish | ||
| version: npx changeset version |
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.
| # 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 |
There was a problem hiding this comment.
We do not use semantic-release anymore (and projects that will use this workflow won't use it either) so this comment should be removed.
| # 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 |
| - next-spec | ||
| - next-major | ||
| - next-major-spec | ||
| - beta | ||
| - alpha | ||
| - next |
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 npx changeset pre enter {tag} then. More investigation is needed.
We can work on it in a second iteration.
There was a problem hiding this comment.
ok sure will do that.
|
I don't fully understand why we created this in a separate PR. The fact we move to changesets is purely linked to the monorepo needs. If something goes wrong, I expect to revert just one commit and not few. Please either add the changes into #1008 or rather change the base branch of this PR to target the one in #1008 so we merge it into that branch. |
Changes Added.
Related issue(s)
Related to: #1028