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, tags, and versioning #38

Closed
ehough opened this issue Apr 5, 2018 · 3 comments
Closed

changelog, tags, and versioning #38

ehough opened this issue Apr 5, 2018 · 3 comments

Comments

@ehough
Copy link
Contributor

ehough commented Apr 5, 2018

I'm curious if you've given any thought to any of the following versioning tools:

As a user, I expect and find it convenient to see a separate changelog, and I found it a little unusual to see one embedded within the script. Was there any reason you went that route?

@mviereck
Copy link
Owner

mviereck commented Apr 6, 2018

Thanks for this inspiration!
Thinking about this, the changelog and versioning can and should be improved. I am not sure which way to choose, I will look closer at the possibilities.

Semantic versioning, though it looks like you may already be adhering to this?

Mainly I am already doing this, but reading the rules again shows me that I should follow this more precisely in future.

As a user, I expect and find it convenient to see a separate changelog, and I found it a little unusual to see one embedded within the script. Was there any reason you went that route?

Just an old habit, no special reason. Mostly I am scripting only for myself, and I like to keep it simple. Having the changelog in the script means, I always know where it is and can see the state of the script.

@mviereck
Copy link
Owner

mviereck commented Apr 7, 2018

I've outsourced the changelog to a file CHANGELOG.md. Looks better now, indeed.

@mviereck mviereck closed this as completed Apr 7, 2018
@ehough
Copy link
Contributor Author

ehough commented Apr 10, 2018

Looks great. And much easier to follow. Nice work!

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

No branches or pull requests

2 participants