The RELEASE-NOTES.md is generated from the announcement.vm and changes.xml. It is in git so a) it will appear in GitHub, b) it is in the root of both the source and binary zips. The source zip is just a copy of the source directory at the time of the build so it has to be committed to git for that.
Ralph > On Jun 29, 2017, at 1:04 PM, Mikael Ståldal <[email protected]> wrote: > > What about the /RELEASE-NOTES.md file? Is it generated? Then why is it in Git? > > On 2017-06-29 21:52, Ralph Goers wrote: >> I should also add that the release manager will be the “final” editor of it >> as part of the release and may make changes, deletions or corrections. >> Ralph >>> On Jun 29, 2017, at 12:50 PM, Ralph Goers <[email protected]> >>> wrote: >>> >>> I wouldn’t use the word “appended”. announcement.vm is free-form text that >>> describes the release. It should be edited as needed. Most enhancements and >>> fixes don’t need to be called out there. >>> >>> Ralph >>> >>>> On Jun 29, 2017, at 12:14 PM, Gary Gregory <[email protected]> wrote: >>>> >>>> Just documenting which file to update and that it gets appended... >>>> >>>> On Jun 29, 2017 12:11 PM, "Ralph Goers" <[email protected]> wrote: >>>> >>>>> Updating the release notes is already a step in the release process. Are >>>>> you talking about a different wiki page? >>>>> >>>>> Ralph >>>>> >>>>>> On Jun 29, 2017, at 10:33 AM, Gary Gregory <[email protected]> >>>>> wrote: >>>>>> >>>>>> Another step in the wiki? >>>>>> >>>>>> Gary >>>>>> >>>>>> On Jun 29, 2017 08:42, "Mikael Ståldal" <[email protected]> wrote: >>>>>> >>>>>>> OK, I just started the good practice. >>>>>>> >>>>>>> >>>>>>> On 2017-06-29 16:53, Ralph Goers wrote: >>>>>>> >>>>>>>> I edit src/site/announcment.vm as required before releases to call out >>>>>>>> anything special. It would be good practice to edit during development >>>>> so >>>>>>>> that I don’t forget things. The changes.xml content gets appended to >>>>> the >>>>>>>> announcement text. >>>>>>>> >>>>>>>> Ralph >>>>>>>> >>>>>>>> On Jun 29, 2017, at 6:02 AM, Mikael Ståldal <[email protected]> wrote: >>>>>>>>> >>>>>>>>> Yes, but in this case I want something more which cannot be placed in >>>>>>>>> changes.xml. >>>>>>>>> >>>>>>>>> On 2017-06-29 14:37, Remko Popma wrote: >>>>>>>>> >>>>>>>>>> Release Notes = changes.xml, no? >>>>>>>>>> (Shameless plug) Every java main() method deserves >>>>> http://picocli.info >>>>>>>>>> >>>>>>>>>>> On Jun 29, 2017, at 19:48, Mikael Ståldal <[email protected]> wrote: >>>>>>>>>>> >>>>>>>>>>> Do we have any place to prepare release notes for an upcoming >>>>> release, >>>>>>>>>>> before actually making the release? >>>>>>>>>>> >>>>>>>>>>> Removing SerializedLayout as default warrants a mentioning in the >>>>>>>>>>> release notes for the 2.9 release, since it is a breaking change. >>>>>>>>>>> >>>>>>>>>> >>>>>>>>> >>>>>>>>> >>>>>>>> >>>>>>>> >>>>>>> >>>>> >>>>> >>>>> >>> > >
