Giters

oasislabs / oasis.js

🕸A web client for the Oasis platform

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Package is missing changelog/release notes

omitar opened this issue · comments

commented

It is really not possible to follow what are changes between versions of this package. I think package should include some changelog/release notes for every release (even rc ones). Ideally every entry should link to an issue and PR related to that entry.

You can use GitHub releases feature, but personally I prefer contents to be in a file in the repository, so that one does not have to depend on GitHub for this information.

commented

Like the fact that all RPC calls are now camelCase even if original method is snake_case. That would be great to read about in the changelog.

commented

Up until quite recently there have been enough known open issues and expected breaking-changes that the changelog/release notes didn't make much sense.

Labeling this as blocked until we hit the 1.0.0 release (we're currently publishing release candidates).

In the mean time, we'll add release notes for @oasislabs/client.

commented

I mean, changelog would be already great to communicate during the development inside of the team. Especially with breaking changes. I upgraded from 1.0.0-rc.14 to 1.0.0-rc.17 and things broke for me. I had to spend quite some time debugging to figure what has changed and how to fix it. I could have just look into the changelog and see what has changed.

we're currently publishing release candidates

Not sure what you mean by this. That release candidates do not need changelogs? I mean, if we are strict here, release candidates should never have breaking changes anyway. They are just for fixing things before release, with frozen API. You are doing major changes inside release candidates series which is pretty bad. But this is just my view. People do all possible things. In any case, changelog is useful to track what "all those possible things" are.

So I would suggest you add changelog early and get it into the release practice now and now wait for 1.0.0.

commented

Then release candidate is the wrong label. Do not expect the API to be stable until 1.0.0.

The last (expected) breaking change is #265.