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

CHANGELOG.md #7

Open
ghost opened this issue Jan 7, 2020 · 2 comments
Open

CHANGELOG.md #7

ghost opened this issue Jan 7, 2020 · 2 comments

Comments

@ghost
Copy link

ghost commented Jan 7, 2020

BLUF: I propose adding change log file and allowing it to trigger automation for releases.

I propose adding a changlog in this format:
https://github.com/majgis/change-log/blob/master/CHANGELOG.md

That repo was an experiment with nodejs cli tool to help creating a standardized changelog based on semver. I want to eventually rewrite the cli in go, and further explore this idea.

For example, we accumulate entries in Unreleased section of change log, categorized as either major, minor or path. Then, when ready to release, it is easy to determine semver (and can also have cli calculate it for you with chlog release). Upon merge to master, if latest version is unpublished, it will publish release automatically for you.

I would follow up after this change, with a PR to add automation for releases based on changes to CHANGELOG.md.

@ntaylor1781
Copy link
Member

Sounds good to me. Do you want to run with that?

@ghost
Copy link
Author

ghost commented Jan 7, 2020

Yes, if you beat me to adding a change, go ahead and populate it.
Otherwise, I'll add it along with automation to push releases.

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

1 participant