* chore: update versions * Update CHANGELOG.md * Update CHANGELOG.md * Update CHANGELOG.md * Update CHANGELOG.md * Update CHANGELOG.md * Update CHANGELOG.md --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: ClarkXia <xiawenwu41@gmail.com> |
||
---|---|---|
.. | ||
README.md | ||
config.json |
README.md
Changesets
Hello and welcome! This folder has been automatically generated by @changesets/cli
, a build tool that works
with multi-package repos, or single-package repos to help you version and publish your code. You can
find the full documentation for it in our repository
We have a quick list of common questions to get you started engaging with this project in our documentation
Add A Changeset
After you have completed a feature or fixed a bug, you need to do three things:
- Select which packages should be released
- Bump released packages version
- Write Changelog for the released packages
You can follow these steps:
- Run the command line script
npm run changeset
- Select the packages you want to include in the changeset using
↑
and↓
to navigate to packages, andspace
to select a package. Hit enter when all desired packages are selected. - You will be prompted to select a bump type for each selected package. Select an appropriate bump type for the changes made. See here for information on semver versioning
- Your final prompt will be to provide a message to go alongside the changeset. This will be written into the changelog when the next release occurs.
After that, you should commit changes to the remote repository. For example:
$ git status
On branch test-3
Untracked files:
(use "git add <file>..." to include in what will be committed)
.changeset/curvy-jobs-fly.md
$ git commit -am "chore: add changeset"
$ git push
For more detail, please see this documentation.
Publish Beta Version
NOTE: You must add a changeset first before publishing beta version.
Run the following command to publish the beta version
$ npm run release:beta
Then, we need to commit changes to the remote repository. For example:
$ git status
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git restore <file>..." to discard changes in working directory)
modified: packages/a/CHANGELOG.md
modified: packages/a/package.json
modified: pnpm-workspace.yaml
Untracked files:
(use "git add <file>..." to include in what will be committed)
.changeset/pre.json
$ git commit -am "chore: beta version"
$ git push
For more detail, please see this documentation.
Publish Latest Version
GitHub bot will automatically create a PR to update the latest versions for the released package.

What we need to do is merge the PR to the release*
branch.