Rely on JIRA for release notes ?

Tom Zeller tzeller at dragonacea.biz
Tue Jul 22 18:26:32 EDT 2014


> I primarily use the release notes to identify bug fixes or changes, but
> not necessarily try and document every new API. The main reason for that
> is that the libraries are a secondary deliverable in this project, and to
> invest the time needed to treat them as a primary deliverable is something
> I consider a roadmap item. Until I'm told to spend my time there, and
> divert it from other things, it's best effort, nothing more.

Agree, but I'll comment that as we move code like the Service stuff
from the IdP into utilities the primary/secondary distinction blurs a
little, I think.

>>but I was wondering if we should generate
>>RELEASE-NOTES.txt from Subversion, since that can be automated.
>
> I think we would need much more discipline in our commit logs for that.

Yup.

>>Also, I think it probably is a good idea to choose a "standard" format
>>for RELEASE-NOTES.txt across the various projects which depend on
>>parent-v3 which should include the date and Subversion revision number
>>of each released version.
>
> On the SP side, I don't bother to even generate them. I include a file
> with links to the page that allows people to generate them for specific
> versions and leave it at that. It's one less thing to maintain.

Providing a link to JIRA is fine with me. I've spent enough time today
and yesterday trying to rationalize RELEASE-NOTES.txt that I'd rather
not.


More information about the dev mailing list