Skip to content

Latest commit

 

History

History
36 lines (22 loc) · 1.74 KB

MAINTAINING.md

File metadata and controls

36 lines (22 loc) · 1.74 KB
Raw

Maintaining yorkie-js-sdk

Releasing a New Version

1. Update the version number.

2. Write changelog of this version in CHANGELOG.md.

Copy the release notes automatically generated by GitHub and categorize them as Added/Changed/Fixed.

  1. Click on the Releases in GitHub.
  2. Click on the Draft a new release button.
  3. Create a new tag.
  4. Click on the Generate release notes button.
  5. Copy the content generated into the body and categorize each item.

image

3. Create Pull Request for changelog and merge it into main.

4. Publish a new release.

After creating the release in step 2, click on the Publish release button.

5. Deploy

When you publish the release in step 4, GitHub action will deploy Yorkie JS SDK to npm.
After that, it will be updated on the cdn after some time.

6. Update examples

  1. Update the version of yorkie-js-sdk in the package.json of each project in the examples folder.
  2. Run and build each project, and if an error occurs, fix it.
  3. Create a pull request and merge it into the main branch.