We don’t *have to*, but it looks *WAY* nicer on Github. From what I’ve seen other projects use wildly different practices when it comes to release notes, but it seems pretty common to have “nice” release notes. In fact most projects I’ve seen seem to have a styled web page which displays release notes.
From what I’ve seen, many projects don’t even seem to be keeping their release notes in their repos. I’m not sure where to read the release notes for Flink. https://github.com/apache/flink <https://github.com/apache/flink> Cloudstack use CHANGES.md which then seems to populate a nicely designed web page https://github.com/apache/cloudstack <https://github.com/apache/cloudstack> https://github.com/apache/cloudstack/blob/master/CHANGES.md <https://github.com/apache/cloudstack/blob/master/CHANGES.md> http://docs.cloudstack.apache.org/projects/cloudstack-release-notes/en/4.6.0/ <http://docs.cloudstack.apache.org/projects/cloudstack-release-notes/en/4.6.0/> Arrow uses a CHANGELOG.md file which then gets populated to a web page. https://github.com/apache/arrow/blob/master/CHANGELOG.md <https://github.com/apache/arrow/blob/master/CHANGELOG.md> http://arrow.apache.org/release/0.8.0.html <http://arrow.apache.org/release/0.8.0.html> etc. I think we can do whatever works nicely… Thanks, Harbs > On Feb 20, 2018, at 6:03 PM, Alex Harui <[email protected]> wrote: > > Why do we have to use markdown in RELEASE_NOTES. Are other ASF projects > doing that? > > -Alex > > On 2/20/18, 5:43 AM, "Piotr Zarzycki" <[email protected] > <mailto:[email protected]>> wrote: > >> Maybe we can exclude from RAT check this file. It is failed because it >> doesn't have Apache header license. >> >> Let me look today evening into options of exclusion some files from RAT >> check. >> >> Thanks, Piotr >> >> 2018-02-20 14:08 GMT+01:00 Gabe Harbs <[email protected]>: >> >>> Can someone more familiar with the maven build look into this? >>> >>> Thanks, >>> Harbs >>> >>>> On Feb 20, 2018, at 3:06 PM, [email protected] wrote: >>>> >>>> This is an automated email from the ASF dual-hosted git repository. >>>> >>>> harbs pushed a commit to branch develop >>>> in repository >>> https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgitbox.a >>> <https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgitbox.a> >>> pache.org >>> <http://pache.org/>%2Frepos%2Fasf%2Froyale-asjs.git&data=02%7C01%7Caharui%40adobe.c >>> om%7C50a4e8f572da474086c808d57867f756%7Cfa7b1b5a7b34438794aed2c178decee1% >>> 7C0%7C0%7C636547310280500614&sdata=H4lG3NGh3Q2B0wGVk25nqxHlZWc0bGd0TqrTUV >>> 9fqd8%3D&reserved=0 >>>> >>>> >>>> The following commit(s) were added to refs/heads/develop by this push: >>>> new aa03fac Revert "Added .md extension to RELEASE_NOTES" >>>> aa03fac is described below >>>> >>>> commit aa03fac44b84f7f07a18682cb5bf456f24b7ef05 >>>> Author: Harbs <[email protected] <mailto:[email protected]>> >>>> AuthorDate: Tue Feb 20 15:06:11 2018 +0200 >>>> >>>> Revert "Added .md extension to RELEASE_NOTES" >>>> >>>> This reverts commit bb5499b394cf6c9f36515c3f6883202116d49e3f. >>>> >>>> It looks like the MAVEN build does not like this name change. >>>> I think the maven build should be fixed and we should use the .md >>> extension. >>>> --- >>>> RELEASE_NOTES.md => RELEASE_NOTES | 0 >>>> 1 file changed, 0 insertions(+), 0 deletions(-) >>>> >>>> diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES >>>> similarity index 100% >>>> rename from RELEASE_NOTES.md >>>> rename to RELEASE_NOTES >>>> >>>> -- >>>> To stop receiving notification emails like this one, please contact >>>> [email protected] <mailto:[email protected]>. >>> >>> >> >> >> -- >> >> Piotr Zarzycki >> >> Patreon: >> *https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.patr >> <https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.patr> >> eon.com <http://eon.com/>%2Fpiotrzarzycki&data=02%7C01%7Caharui%40adobe.com >> <http://40adobe.com/>%7C50a4e8f572da47 >> 4086c808d57867f756%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C6365473102 >> 80500614&sdata=0iB06Uoq8M3Nj%2BMViiIB9AZqxEdIVSKkSKBuDurNKt8%3D&reserved=0 >> <https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.patr >> <https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.patr> >> eon.com <http://eon.com/>%2Fpiotrzarzycki&data=02%7C01%7Caharui%40adobe.com >> <http://40adobe.com/>%7C50a4e8f572da47 >> 4086c808d57867f756%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C6365473102 >> 80500614&sdata=0iB06Uoq8M3Nj%2BMViiIB9AZqxEdIVSKkSKBuDurNKt8%3D&reserved=0 >>> *
