URL:
https://github.com/SSSD/sssd/pull/5257
Title: #5257: git-template: add tags to help with release notes automation
elkoniu commented:
"""
When I submitted a contribution to Ansible, they wanted me to provide
a [release notes
fragment](https://github.com/ansible/ansible/tree/devel/changelogs).
Little digging revealed that they are using a tool
[
reno](https://docs.openstack.org/reno/latest/user/usage.html) developed by Openstack. The
idea is similar to what I suggested but instead of describing the changes in a commit
message you describe it in a file. The files are deleted with new release. One of the
advantages in this approach is that it can actually detect that a patch was reverted (the
file is not present anymore) and you can fix typos any time which would be hard if it is
in commit message.
I believe this is worth trying out. We wouldn't have to implement the parser
ourselves, it seems to be flexible and it can be directly integrated with sphinx. It would
also make it easier to provide more granularity as Pawel suggested. And of course we will
not be hitting this silly conflict with emojis :-)
To summarize I think we may stick with this idea and start playing with it. One thing is
that some howto will be needed for sure or some example in our documentation. Also I am
thinking if it is possible to put some automation in creating those files using some git
hooks? We should try to avoid situation where we may have to bounce off community
contributions due to some missing side data for our automation.
"""
See the full comment at
https://github.com/SSSD/sssd/pull/5257#issuecomment-675062463