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 change log entries for v2.20 release #1772

Closed
decentral1se opened this issue Feb 22, 2019 · 7 comments
Closed

Add change log entries for v2.20 release #1772

decentral1se opened this issue Feb 22, 2019 · 7 comments

Comments

@decentral1se
Copy link
Contributor

This is a bit painful and unfortunate that we've been missing the entries.

We should add entries for user facing changes for the next release.

See https://github.com/ansible/molecule/projects/2 for more.

@decentral1se decentral1se added this to the v2.20 milestone Feb 22, 2019
@webknjaz
Copy link
Member

How about using towncrier or reno for that?

@decentral1se
Copy link
Contributor Author

decentral1se commented Feb 25, 2019

I really like the look of towncrier! Any reasons to chose one over the other? I'm open!

Here's the user facing changes/fixes/etc. that I see from https://github.com/ansible/molecule/projects/2:

I probably missed some and there have been looaaddsss more work done on internals of project maintenance! I probably won't have time to compile this today into the CHANGELOG.md but will later in the week. Hoping to see movement on a pre-release today if not this week! 👍

@webknjaz
Copy link
Member

@decentral1se you can do a pre-release v2.20a0 and then release a follow-up pre-release v2.20a0.post0 as soon as you're done with changelog. It should be that flexible.

P.S. See https://www.python.org/dev/peps/pep-0440/#post-releases for chaining sub-release versions details

@webknjaz
Copy link
Member

Regarding automation.

I've got several projects using towncrier and it's very easy to use, yet it's got some limitations (I think it's one-lined markdown so it's usually one sentence, IIRC).

Ansible uses reno. It's way more complicated. Users have to add YAML files with proper keys instead of adding just files with extensions and text. It's also challenging to integrate, I was trying to do it for virtualenv or tox (I don't remember) a while back but failed, which feels discoraging. OTOH, Ansible has a wrapper script for running log generation.
It is an OpenStack project and seamlessly integrates with pbr and SphinX.

So I vote for towncrier as it's simpler. Unless anyone has other opinions, I'd like to avoid reno. Otherwise, somebody else will have to figure out the integration part.

@decentral1se
Copy link
Contributor Author

TODO #1797 (comment)

@decentral1se
Copy link
Contributor Author

RE: automation, see #1779 (comment).

We'll compile this manually for v2.20 👍

See latest WG logs.

decentral1se added a commit to decentral1se/molecule that referenced this issue Mar 10, 2019
Closes ansible#1772.

Signed-off-by: Luke Murphy <[email protected]>
@decentral1se
Copy link
Contributor Author

Taken a stab at this in #1816!

decentral1se added a commit to decentral1se/molecule that referenced this issue Mar 11, 2019
Closes ansible#1772.

Signed-off-by: Luke Murphy <[email protected]>
gundalow pushed a commit that referenced this issue Mar 11, 2019
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

2 participants