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

Maintain changelog and have tags #17

Open
sb10 opened this issue Apr 6, 2020 · 2 comments
Open

Maintain changelog and have tags #17

sb10 opened this issue Apr 6, 2020 · 2 comments

Comments

@sb10
Copy link
Contributor

sb10 commented Apr 6, 2020

I appreciate the workflow is under active development, but by necessity we are using it production.

It would generally be useful to have a CHANGELOG.md in the format of http://keepachangelog.com/.

It would also be valuable to start version tagging master (to correspond to each section of the CHANGELOG.md), so that those using the workflow in production can pick a version to use and easily understand what that version comprises, and decide if and when they should go through an update process.

Since it's used in production, I'd propose starting with v1.0.0 now, and incrementing the version as per http://semver.org/ rules for each merge to master. Major version would change if there are any backwards-incompatible changes to parameter names or meanings.

@m-bull
Copy link
Contributor

m-bull commented Apr 6, 2020

Thanks for the helpful links and advice. As I've merged a large quantity of PRs today and made some decent refactors on top of those to preserve the readability and style of the workflow, I guess now is a good time to start this.

@mgcam
Copy link
Contributor

mgcam commented Sep 22, 2020

Would be nice to start using tags.

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