Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update readme for release guide #238

Merged
merged 2 commits into from
Jan 2, 2025
Merged

doc: update readme for release guide #238

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dfe574e
doc: update readme for release guide
ldhyen99 Dec 31, 2024
58cb0ed
doc: update readme for release guide
ldhyen99 Jan 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,3 +164,30 @@ The `scripts/release-doc.js` script automates the process of creating new docume
# Run the release script
pnpm release:doc
```

### Release Guide

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 `next` with the version number as the branch name.
2. Update the `version.json` file with the new version number.
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:

```json
{
"version": "MAJOR.MINOR.PATCH",
"apiVersion": "MAJOR.MINOR.PATCH",
"docVersion": "MAJOR.MINOR.PATCH",
"dependencies": {}
}
```

We need to change manually the `version`, `apiVersion`, and `docVersion` fields.
Loading