Skip to content
This repository has been archived by the owner on Mar 10, 2020. It is now read-only.

Add a changelog #143

Closed
dignifiedquire opened this issue Nov 23, 2015 · 11 comments
Closed

Add a changelog #143

dignifiedquire opened this issue Nov 23, 2015 · 11 comments

Comments

@dignifiedquire
Copy link
Contributor

We should add a changelog (and auto generated if possible on releases, though this depends on us having a decent commit message convention and enforcing it)

https://github.com/ajoslin/conventional-changelog

Discuss :)

@fazo96
Copy link

fazo96 commented Nov 23, 2015

I think the most important thing is clear commit messages, also I see there is a little amount of commits between releases, so I don't think generating a changelog is very useful

@Mithgol
Copy link
Contributor

Mithgol commented May 14, 2016

I've encountered a necessity of a changelog. Today I am not sure why version 4.0.0 is a major version (in other words, what are the backwards-incompatible changes in it).

@daviddias
Copy link
Contributor

It were changes on the Object API that now follows the spec defined on https://github.com/ipfs/interface-ipfs-core#object, you should be able to use almost as you were using, with the different that you now have to call on the return object (the dagNode), .toJSON() to get a JSON format of the results (which will bring more info than sometimes just the Hash)

Agree on having a changelog 👍

@Mithgol
Copy link
Contributor

Mithgol commented Jun 6, 2016

I've encountered a necessity of a changelog.

Once again.

This time it took the form of TypeError: IPFSAPI(...).add is not a function.

@daviddias
Copy link
Contributor

Apologies @Mithgol, didn't want to cause any pain migrating. We created a (probably too small) entry on https://github.com/ipfs/js-ipfs-api/releases/tag/v5.0.0.

However, I'm surprised that .add stopped being a function as we created aliases here https://github.com/ipfs/js-ipfs-api/blob/master/src/load-commands.js#L32-L34.

What version are you running?

@Mithgol
Copy link
Contributor

Mithgol commented Jun 7, 2016

I've tried version 5.0.1, but the problem seems to persist in version 6.0.1 as well.

Here's a screenshot for 6.0.1:

(screenshot)

@Mithgol
Copy link
Contributor

Mithgol commented Jun 7, 2016

Here's a screenshot of the same method working in v4.1.0:

(screenshot)

(Not very clean because I forgot to require the module from the start. But anyway.)

@dignifiedquire
Copy link
Contributor Author

We will be doing this together with ipfs/aegir#30

@daviddias
Copy link
Contributor

In addition to the (soon to be) changelog, we now have:

And are working towards making this experience less painful on: https://github.com/ipfs/http-api-spec/issues/116

@daviddias
Copy link
Contributor

We have changelogs now :D https://github.com/ipfs/js-ipfs-api/releases \o/

@Mithgol
Copy link
Contributor

Mithgol commented Oct 30, 2016

Excellent. Thanks.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants