revdotcom/revai-node-sdk

Add changelog or release notes

Closed this issue · 5 comments

hisabimbola commented

Hello,

We're using this library for our RevAI integration and seeing that some updates are being made but there is no public documentation to understand what breaking changes or new features are being added. Is it possible to add the support for this?

Thansk

amikofalvy commented

There is public documentation for the Node SDK changelog

https://docs.rev.ai/sdk/node/changelog/

amikofalvy commented

I will add a link to this changelog in the readme to increase visibility.

hisabimbola commented

Thanks for the fast response @amikofalvy.

  1. Looking at the linked changelog, I can't see the breaking change for v3.0.0 I can't only see fixes and new feature. Can you double check that this is correct or maybe there is a breaking change that is not documented?
  2. In addition to the website, is it possible to add the changelog to the repo. There are industry standard dependency management tools that parses opensource libraries and extracts the changelog when proposing an update. For renovate this is missing because it's not on the repo.
amikofalvy commented

I recall the discussion around bumping the major version of the package. It was introduced in this PR/commit: #76 (comment)

In short, we made a breaking change to the streaming client which is not independently versioned from the asynchronous client so we felt obligated to increase the major version.

If you are using one of the async clients then there should not be a breaking change for your use case.

amikofalvy commented

Separately, the engineering team can look into using the GitHub release notes feature. In the past we have not used that functionality. Instead preferring our own change log because of its flexibility.

I cannot promise a timeline for when the team would be be able to look in to this. You are always welcome to submit a PR if you would like to see a change that benefits the community altogether.