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

changelogs? #11

Open
meowsbits opened this issue Feb 1, 2019 · 5 comments
Open

changelogs? #11

meowsbits opened this issue Feb 1, 2019 · 5 comments
Labels
pre-1.0 question Further information is requested

Comments

@meowsbits
Copy link
Member

meowsbits commented Feb 1, 2019

re: https://github.com/etclabscore/pristine/blob/master/RELEASING.md#generate-changelog

Don’t let your friends dump git logs into changelogs.
https://keepachangelog.com/en/1.0.0/

This is just a devil's advocate note. Personally I'd be pretty inclined to use programmatic means to handle what I would consider to be a chore of handling changelog maintenance.

With that said... Do we really need changelogs as a standard-across-the-board artifact? For me, to answer questions around what has been happening on the development of projects I typically use a combination of git logs, release notes, the github issue tracker, and, if necessary, an internet search engine. I don't know if a changelog has ever held my attention for more than 4 seconds.

@meowsbits meowsbits added the question Further information is requested label Feb 1, 2019
@meowsbits
Copy link
Member Author

Also, handling changelog maintenance carries a relatively lot of complexity, especially if it's programmatically generated... should it be edited before a tag? Before a release? Before a push? Should we be validating these expectations on the CI? Do we want git hooks to manage this?

@shanejonas
Copy link
Contributor

shanejonas commented Feb 1, 2019

heres an example of a tool that takes care of this process that aligns with our specs: https://github.com/semantic-release/semantic-release#release-steps

@shanejonas
Copy link
Contributor

i think the big reason this should be automated stems from this:

This removes the immediate connection between human emotions and version numbers, strictly following the Semantic Versioning specification.

@shanejonas
Copy link
Contributor

the changelogs are also used to make the release notes for github releases. its all part of the same thing IMO

@shanejonas
Copy link
Contributor

rel #13
rel #14

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pre-1.0 question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants