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

Add release notes #89

Closed
ImrePyhvel opened this issue Jan 11, 2019 · 2 comments
Closed

Add release notes #89

ImrePyhvel opened this issue Jan 11, 2019 · 2 comments

Comments

@ImrePyhvel
Copy link

It is currently totally opaque what is happening with this library between versions, including when it is safe to upgrade. Or even if the version numbers follow semantic versioning convention or are just randomly incrementing.

For example, I once used 2.0.6, what will change if I upgrade to 2.0.20? Any breaking changes? Any bugs fixed? Any new features I should consider?

Please do introduce release notes or change log of some kind.

As an addition it would be a welcome practice to tag releases in codebase should anyone need to compare specific issues and do have commits linked to issues they are related to.

@kzu
Copy link
Member

kzu commented Oct 15, 2019

Totally valid point. Since there are usually few changes across versions, and they increment based on commit count, it should be fairly easy to compare, but the fact that I'm not exposing the commit info anywhere in the package makes it harder than it needs to be.

I'll add build metadata so you can at least compare one version's sha to another and get a commit list, which should be self-describing for the most part.

@kzu
Copy link
Member

kzu commented Aug 26, 2021

Done! Checkout the latest release ones: https://github.com/devlooped/GitInfo/releases/tag/v2.2.0

@kzu kzu closed this as completed Aug 26, 2021
@devlooped devlooped locked and limited conversation to collaborators Sep 12, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants