Automatic changelog

[jykae]

To reduce manual work for releases,
try out https://github.com/skywinder/github-changelog-generator

Definition of done

• Check the options for creating automatic changelog and make a proposal

[55]

Tried out GitHub Changelog Generator, works like a charm.
Output example was generated by command:

github_changelog_generator --token [my token]

Usage:
https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples#basic-usage

Here are the alternatives:
https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives

To sum up, I propose to start using GitHub Changelog Generator to automatically generate changelogs for releases.

[55]

@bajiat let me know, if you need a demo for this.

[jykae]

Great that you decided to embrace automation :)

[55]

Tested with @bajiat on Windows. Couldn't make it work, due to existing bug, but since she is switching to Ubuntu, won't spend time now to make it work on Windows (possible solution).

@apinf/developers if anybody has a desire to test this package - please do. If you have other suggestions, post them here.

[shaliko]

@NNN @bajiat We can create simple web app, that will generate for us report from browser, based on "https://github.com/skywinder/github-changelog-generator".

[55]

@shaliko yeah, sure, it would be nice, but I think it doesn't worth our efforts, since this is just a biweekly dealio.

[shaliko]

Docker version:

docker run -it --rm -v $(pwd):/app prooph/github-changelog-generator --token=067c491e.... --since-tag=0.39.0  -u apinf -p platform

[55]

@brylie @bajiat ready for review. What are next steps here?

[brylie]

It seems like, to some extent, this process relies on Github metadata such as label, milestone, issue description, etc.

As a follow up to this task, we should include some brief note(s) about how our development process should use the Github metadata, so this package will correctly identify our changes. E.g. what labels does it look for?

[bajiat]

@NNN Could you create the changelog.md file to apinf develop branch? We could close the issue after that.

[frenchbread]

Here is one possible approach for generating changelogs - conventional-changelog

Tested it just now & works fine. Basically all that is needed is an NPM package installed globally. So it should work on Windows as well.

This lib has an Atom extension as well, but I couldn't get it working there