On Wed, May 16, 2012 at 1:54 AM, Jody Garnett <jody.garn...@gmail.com>wrote:
> The second thing I would like to discuss is how we handle the README.
> Currently when we release we update the README on the main branch (and not
> the tag). I would kind of like to avoid committing anything to the main
> branch in an automated process. For example what happens if we run the
> release, it fails and we run it again. We have to check if the readme has
> been already updated, etc... While certainly possible with some script mojo
> it seems like an error prone process I would like to avoid.
>
> So what I would like to propose is the following. We don't ever update the
> README on the main release branch. We leave it generic with information
> about the project, where to find the docs, etc... On the tag we create we
> would generate a new file called "RELEASE_NOTES.txt" (or something to that
> effect) that contains the stuff we usually put in the README like revision
> info and the new and noteworthy info for that release. To generate the new
> and noteworthy for the release notes i was thinking we could come up with a
> heuristic. One such heuristic could be to pull out any new feature or
> improvement, and perhaps any issue that is a high priority one. Anyways,
> you get the idea. And naturally it would contain the link to the entire
> changelog from jira like we do now. Perhaps we should just stick to simple
> and put the revision info and the changelog link in the release notes.
> Probably what I will do for a first pass if people are into the idea.
>
> I would look a lot better if you could generate a README.html using:
> - the boiler plate README from the main branch
> - idea: pull the release description from JIRA (if it is available ) and
> use it for the release specific description.
> - a link to the release notes in JIRA; optionally include a list of the
> "closed" items (as a highlights) and then offer a link through to JIRA for
> more information
> - (Wish) the features are often best summed up in the associated blog
> posts that have been made; could we troll the various geoserver, opengeo,
> geo-solutions blogs for a tag matching the release number - and provide
> links out to that information.
>
> Thanks for the hard work on this justin; when I was on IRC I saw geotools
> patches still being applied - is the coast clear now?
>
Yup, had a few patches yesterday i wanted to get in, all good to go know
though.
> Jody
>
>
--
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.
------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and
threat landscape has changed and how IT managers can respond. Discussions
will include endpoint security, mobile security and the latest in malware
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Geoserver-devel mailing list
Geoserver-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geoserver-devel
