Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] Changelog #275

Closed
conradkirschner opened this issue Aug 26, 2020 · 5 comments
Closed

[Feature] Changelog #275

conradkirschner opened this issue Aug 26, 2020 · 5 comments

Comments

@conradkirschner
Copy link

Hi,

I see a lot changes in this repo, but it was quite hard to look into the git log to find out what actual changed.

A changelog would give me a better overview what is going on :)

If I overlooked it, I am sorry for it.

@vania-pooh
Copy link
Member

vania-pooh commented Aug 27, 2020

@conradkirschner basically we migrated from bash scripts to Golang binary doing the same logic (except Android for the moment). This wasn't yet released but new commands are already in README.md.

@conradkirschner
Copy link
Author

I was more into the permission fixes, if you had included it and how you did it... :D (As my pull request wasn't that good)
That's why I was digging in the git log.

It's more a general thing for all your open repos, looking into gitlog to find out what changed is harder than read a small changelog...

But it's up to you, if you dislike changelogs for any reason (too time consuming) just close this request and I will stay with the gitlog

More Help if you like Changelogs or not:

https://keepachangelog.com/en/1.0.0/

@vania-pooh
Copy link
Member

@conradkirschner I think we could start adding changelog to Github releases like we do e.g. for Selenoid.

@Expoverse
Copy link

Expoverse commented Aug 27, 2020

It's possible to auto generate a change log from git tags and commit history. So instead of starting MORE work, let most of it be automated. Which provides a clearer communication to consumers and developers on exactly what happened in the version being released.
https://github.com/CookPete/auto-changelog is a simple tool to save time on rewriting every change into a change log. This also can be applied to the Selenoid project to keep everything smooth and undifferentiated.

Below is an exact raw copy and paste of the change log generated by this tool

Note: You can click this link(changelog) to view it in a separate tab. Also you can hover over the blue links to see information related to issues and more.

Changelog

All notable changes to this project will be documented in this file. Dates are displayed in UTC.

Generated by auto-changelog.

v2.2.0

3 July 2020

  • add --prepend option as altenative to prepend-token #172
  • Fix bug when no existing tags #170

v2.1.0

14 June 2020

  • Add --hide-credit option #166
  • Add --unreleased-only option #165
  • Fix --starting-version #164
  • Add ability to prepend to an existing changelog #156
  • Use tag date rather than first commit date #162
  • Add CONTRIBUTING.md #141
  • Add merge and fix support to commit-list helper #146

v2.0.0

10 April 2020

  • Refactor codebase #144
  • Breaking change: Remove the need for core-js and building with babel 2383380
  • Breaking change: Refactor git data fetching logic 09325ac
  • Improve progress output a2ba4ac

v1.16.4

2 April 2020

  • Pin semver to v6 #160
  • Add node 12 to travis builds ac77a53
  • Remove node 8 from travis builds e7d557d

vania-pooh added a commit that referenced this issue Aug 28, 2020
Added release drafter (fixes #275)
@vania-pooh
Copy link
Member

@conradkirschner are you seeing this under releases page?
Screen Shot 2020-08-28 at 07 19 40

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

No branches or pull requests

3 participants