You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Changeset automates a lot of the tedious actions, for example updating the version manually or creating relevant information on what the PR does.
Changeset
Changing to changeset requires the contributor to add a changeset in its PR. A changeset A changeset is a piece of information about changes made in a branch or commit. It generates a unique file containing different information.
For example:
---
"@meilisearch/instant-meilisearch": minor
---
I did something in this PR
Version Update
When running changeset version all the files are merged into the CHANGELOG of the related package. In the case above it updates (or creates) the CHANGELOG of the @meilisearch/instant-meilisearch package (and not the others).
In our case it would generate this:
# @meilisearch/instant-meilisearch
## 0.11.0
### Minor Changes
- I did something
It also updates the version in the related package based on whether the changesets asked for a major, minor or patch update. In our case, we asked for a minor update, so the package.json of @meilisearch/instant-meilisearch has its version updated to 0.11.0.
Publish
Finally, based on the packages that saw their version updated, the publish function will only publish the affected packages.
Process
We want users to not use changeset publish or changeset version locally. This should be handled by the CI. changesets has a dedicated github actionto handle that.
In this action we want the following:
On each push to main, the CI should update a PR it created with the updated changelogs and versions. Example
When the PR is merged, the CI should generate both a github release for the related packages (see example) and publish then on npm.
Todo
Add changesets configuration to the repo
Update the contributing guide with the new required changeset that has to be added on every PR
Update the publish CI to follow the process described above
Handle pre-releases and beta versions
The text was updated successfully, but these errors were encountered:
965: Add changesets publish process r=bidoubiwa a=bidoubiwa
This PR adds a release process for the packages.
Some documentation links are provided in the yaml to provide quick link to understand the commands.
A full explanation is provided in the CONTRIBUTING guide.
the `checkr-release.sh` and `check-tag-format.sh` scripts are removed.
The check-release is redundant as changesets takes care of updating the versions.
the check tag format is also removed as the CI will not trigger if the format is bad.
FIxes: #959
Co-authored-by: Charlotte Vermandel <charlottevermandel@gmail.com>
With the migration to #939 we need to change the way we handle publishes on github but also on
npm
.The tool suggested by turborepo is changeset.
Changeset automates a lot of the tedious actions, for example updating the version manually or creating relevant information on what the PR does.
Changeset
Changing to changeset requires the contributor to add a
changeset
in its PR. A changeset A changeset is a piece of information about changes made in a branch or commit. It generates a unique file containing different information.For example:
Version Update
When running
changeset version
all the files are merged into the CHANGELOG of the related package. In the case above it updates (or creates) the CHANGELOG of the@meilisearch/instant-meilisearch
package (and not the others).In our case it would generate this:
It also updates the version in the related package based on whether the changesets asked for a major, minor or patch update. In our case, we asked for a
minor
update, so the package.json of@meilisearch/instant-meilisearch
has its version updated to0.11.0
.Publish
Finally, based on the packages that saw their version updated, the publish function will only publish the affected packages.
Process
We want users to not use
changeset publish
orchangeset version
locally. This should be handled by the CI.changesets
has a dedicated github actionto handle that.In this action we want the following:
npm
.Todo
changesets
configuration to the repoThe text was updated successfully, but these errors were encountered: