[openstack-dev] Thoughts on ReleaseNoteImpact git commit message tag

Dan Smith dms at danplanet.com
Tue Jul 7 16:35:13 UTC 2015

> The thing is, UpgradeImpact isn't always appropriate for the change, but
> DocImpact is used too broadly and as far as I can tell, it's not really
> for updating release notes [2].  It's for updating stuff found in
> docs.openstack.org.
> So we kicked around the idea of a ReleaseNoteImpact tag so that we can
> search for those at the end of the release in addition to UpgradeImpact.

So, I find that it's much better to write the release notes at the time
we merge the thing. I have previously done that for things like the
flavor migration stuff.

How about we just hold off on the +W until the author writes the actual
release note themselves? We could also have something like a tag for
[pending review 123456] in the release notes in case something never
merges so we can strip it later.

Anyway, the summary is: using a tag on the commit and constructing the
release notes later seems suboptimal to me. Being better about writing
release notes as we do things seems like a major win though.


More information about the OpenStack-dev mailing list