introduce Changelog file to quickly track changes

[gogolok]

It's hard to get a quick overview what has changed between version 0.1.8 and 0.1.9.
It would be nice to have a Changelog file.

[swanandp]

Good idea.

[philippfranke]

+1

[swanandp]

@gogolok Any suggestions on doing it for historical data?

[gogolok]

@swanandp Maybe in the Wiki?

[philippfranke]

How about creating a markdown file? Headlines represent the version and unordered lists are the changes. Like:

# 0.1.6 (November 4th, 2012)
** Bugs **
- Fixing ...
- ...
** Features **
- ...

# Previous
Previous changes can be seen by reading the commit messages.

/cc @swanandp @gogolok

[fabn]

+1

[gogolok]

+1

[fabn]

@swanandp, you should really consider this. I've just updated my bundle and I got couple of tests failing and I don't know why. For the moment I've pinned aal to version 0.4.0, then I'll use github diff tool to find what's changed in range 0.4.0..0.6.0 but this is really painful.

Please take care of us 🙏

[swanandp]

Yup, I've been negligent on this so far. But no more. I'll see if I can do retrospective changelog.

[twelvelabs]

Please, please, please can you add a changelog? It's very tedious to have to use github's compare when updating apps w/ many dependencies.

[fabn]

Still no trace of changelog 😢 😢

[swanandp]

Sorry to disappoint you folks, this task is more tedious than it sounds. But I hope to wrap this up soon.

[fabn]

@swanandp I understand this is boring. However and quick and pretty easy fix would be to introduce a changelog file and start to use it right now for every important change (bugfix or new feature). Alternatively github releases feature is also good.

For past releases a github compare link would be enough (and easy to add), however this repo has no tags thus I can't submit a PR for that. Do you have some way to tag past releases?

[fabn]

You can tag past releases using rubygems changelog and for the future use bundler gem tasks to release the gem, in this way it will be automatically tagged and pushed to github.

[fabn]

Addressed by #177

[fabn]

Changelog file has been generated and it's now present in master branch