Skip to content

Commit

Permalink
doc: update readme for release guide
Browse files Browse the repository at this point in the history
  • Loading branch information
ldhyen99 committed Jan 2, 2025
1 parent dfe574e commit 58cb0ed
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,13 +169,15 @@ pnpm release:doc

To release a new version, ensure we have the `version.json` file updated with the new version number. Then, create a new release tag with the following steps:

1. Create a new release branch from `main` with the version number as the branch name.
1. Create a new release branch from `next` with the version number as the branch name.
2. Update the `version.json` file with the new version number.
3. Commit the changes and push the branch.
4. Create a pull request from the release branch to `main`.
5. Merge the pull request.
6. Create a new release tag with the version number.
7. Push the tag to the repository.
3. Generate new documentation version using the release script `yarn release:doc`.
4. Check API documentation and update if necessary.
5. Commit the changes and push the branch.
6. Create a pull request from the release branch to `main`.
7. Merge the pull request.
8. Create a new release tag with the version number.
8. Push the tag to the repository.

(\*) With the `version.json` file, it contains the version number in the following format:

Expand Down

0 comments on commit 58cb0ed

Please sign in to comment.