OK, then make sure you update the build scripts to exclude from RAT and copy the right files and you should be all set. I don't like it as a release reviewer, but that might be just me. Also note that we package all 3 repos into one package so the RELEASE_NOTES at the top of each repo is not necessarily the RELEASE_NOTES at the top of the official release package. There is a RELEASE_NOTES in royale-asjs/releasemgr that goes in the top of the source package. I can't find any rules and regulations on a RELEASE_NOTES file so I think is is probably ok if the RELEASE_NOTES in releasemgr remains plain text and points to the other RELEASE_NOTES files.
-Alex On 2/20/18, 8:23 AM, "Gabe Harbs" <[email protected]> wrote: >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://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.co >m%2Fapache%2Fflink&data=02%7C01%7Caharui%40adobe.com%7C1ef1569c54d24fe771b >308d5787e5b70%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636547406449130 >871&sdata=Nr4OzZOoi3UDlw9mt2tvWdJC0jLXCf5QnzTHjxn6mQQ%3D&reserved=0 ><https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.c >om%2Fapache%2Fflink&data=02%7C01%7Caharui%40adobe.com%7C1ef1569c54d24fe771 >b308d5787e5b70%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C63654740644913 >0871&sdata=Nr4OzZOoi3UDlw9mt2tvWdJC0jLXCf5QnzTHjxn6mQQ%3D&reserved=0> > >Cloudstack use CHANGES.md which then seems to populate a nicely designed >web page >https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.co >m%2Fapache%2Fcloudstack&data=02%7C01%7Caharui%40adobe.com%7C1ef1569c54d24f >e771b308d5787e5b70%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C6365474064 >49130871&sdata=MF1RDcIskN%2FNdFjwwGoE0hSu%2F%2Fb9rvSqWvIUkogcrXM%3D&reserv >ed=0 ><https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.c >om%2Fapache%2Fcloudstack&data=02%7C01%7Caharui%40adobe.com%7C1ef1569c54d24 >fe771b308d5787e5b70%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636547406 >449130871&sdata=MF1RDcIskN%2FNdFjwwGoE0hSu%2F%2Fb9rvSqWvIUkogcrXM%3D&reser >ved=0> >https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.co >m%2Fapache%2Fcloudstack%2Fblob%2Fmaster%2FCHANGES.md&data=02%7C01%7Caharui >%40adobe.com%7C1ef1569c54d24fe771b308d5787e5b70%7Cfa7b1b5a7b34438794aed2c1 >78decee1%7C0%7C0%7C636547406449130871&sdata=Y8uUg3zXZbsOKdHBrJKbDJJwFe9sY8 >9pCGrX23P8wtM%3D&reserved=0 ><https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.c >om%2Fapache%2Fcloudstack%2Fblob%2Fmaster%2FCHANGES.md&data=02%7C01%7Caharu >i%40adobe.com%7C1ef1569c54d24fe771b308d5787e5b70%7Cfa7b1b5a7b34438794aed2c >178decee1%7C0%7C0%7C636547406449130871&sdata=Y8uUg3zXZbsOKdHBrJKbDJJwFe9sY >89pCGrX23P8wtM%3D&reserved=0> >https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdocs.cloud >stack.apache.org%2Fprojects%2Fcloudstack-release-notes%2Fen%2F4.6.0%2F&dat >a=02%7C01%7Caharui%40adobe.com%7C1ef1569c54d24fe771b308d5787e5b70%7Cfa7b1b >5a7b34438794aed2c178decee1%7C0%7C0%7C636547406449130871&sdata=BqZhUoJDgngt >0GFn%2FY0Wzlik34h0lknRcFueK4D9apU%3D&reserved=0 ><https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdocs.clou >dstack.apache.org%2Fprojects%2Fcloudstack-release-notes%2Fen%2F4.6.0%2F&da >ta=02%7C01%7Caharui%40adobe.com%7C1ef1569c54d24fe771b308d5787e5b70%7Cfa7b1 >b5a7b34438794aed2c178decee1%7C0%7C0%7C636547406449130871&sdata=BqZhUoJDgng >t0GFn%2FY0Wzlik34h0lknRcFueK4D9apU%3D&reserved=0> > >Arrow uses a CHANGELOG.md file which then gets populated to a web page. >https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.co >m%2Fapache%2Farrow%2Fblob%2Fmaster%2FCHANGELOG.md&data=02%7C01%7Caharui%40 >adobe.com%7C1ef1569c54d24fe771b308d5787e5b70%7Cfa7b1b5a7b34438794aed2c178d >ecee1%7C0%7C0%7C636547406449130871&sdata=xcY4xDNYXXDX98L%2BNjScnn7GYC6ioJ0 >dLerSl8AgPss%3D&reserved=0 ><https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.c >om%2Fapache%2Farrow%2Fblob%2Fmaster%2FCHANGELOG.md&data=02%7C01%7Caharui%4 >0adobe.com%7C1ef1569c54d24fe771b308d5787e5b70%7Cfa7b1b5a7b34438794aed2c178 >decee1%7C0%7C0%7C636547406449130871&sdata=xcY4xDNYXXDX98L%2BNjScnn7GYC6ioJ >0dLerSl8AgPss%3D&reserved=0> >https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Farrow.apac >he.org%2Frelease%2F0.8.0.html&data=02%7C01%7Caharui%40adobe.com%7C1ef1569c >54d24fe771b308d5787e5b70%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C6365 >47406449130871&sdata=CS%2BCDEvhZhNVDy7fRAR7XHZbLi3jBBRBuLrbrq%2B0XMw%3D&re >served=0 ><https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Farrow.apa >che.org%2Frelease%2F0.8.0.html&data=02%7C01%7Caharui%40adobe.com%7C1ef1569 >c54d24fe771b308d5787e5b70%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636 >547406449130871&sdata=CS%2BCDEvhZhNVDy7fRAR7XHZbLi3jBBRBuLrbrq%2B0XMw%3D&r >eserved=0> > >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%2Fgitbo >>>>x.a> >>>> pache.org >>>><https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fpache. >>>>org%2F&data=02%7C01%7Caharui%40adobe.com%7C1ef1569c54d24fe771b308d5787e >>>>5b70%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636547406449130871&sd >>>>ata=kJbJt6OatAJf4UqVpKHPfR27en4aTX9H6hc0VgEKDKg%3D&reserved=0>%2Frepos% >>>>2Fasf%2Froyale-asjs.git&data=02%7C01%7Caharui%40adobe.c >>>> >>>>om%7C50a4e8f572da474086c808d57867f756%7Cfa7b1b5a7b34438794aed2c178decee >>>>1% >>>> >>>>7C0%7C0%7C636547310280500614&sdata=H4lG3NGh3Q2B0wGVk25nqxHlZWc0bGd0TqrT >>>>UV >>>> 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.pa >>>tr >>><https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.pa >>>tr> >>> eon.com >>><https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Feon.com >>>%2F&data=02%7C01%7Caharui%40adobe.com%7C1ef1569c54d24fe771b308d5787e5b70 >>>%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636547406449130871&sdata=t >>>r4I4OqEOdMN9sYyHrQFcY9RCwoxZoPO%2BoaFu5wFPps%3D&reserved=0>%2Fpiotrzarzy >>>cki&data=02%7C01%7Caharui%40adobe.com >>><https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2F40adobe >>>.com%2F&data=02%7C01%7Caharui%40adobe.com%7C1ef1569c54d24fe771b308d5787e >>>5b70%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636547406449130871&sda >>>ta=csv29dcqhaEqGECe5EogEtI%2F6YYiPlh9zzAqkQfCp%2Fk%3D&reserved=0>%7C50a4 >>>e8f572da47 >>> >>>4086c808d57867f756%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C63654731 >>>02 >>> >>>80500614&sdata=0iB06Uoq8M3Nj%2BMViiIB9AZqxEdIVSKkSKBuDurNKt8%3D&reserved >>>=0 >>> >>><https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.pa >>>tr >>><https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.pa >>>tr> >>> eon.com >>><https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Feon.com >>>%2F&data=02%7C01%7Caharui%40adobe.com%7C1ef1569c54d24fe771b308d5787e5b70 >>>%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636547406449130871&sdata=t >>>r4I4OqEOdMN9sYyHrQFcY9RCwoxZoPO%2BoaFu5wFPps%3D&reserved=0>%2Fpiotrzarzy >>>cki&data=02%7C01%7Caharui%40adobe.com >>><https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2F40adobe >>>.com%2F&data=02%7C01%7Caharui%40adobe.com%7C1ef1569c54d24fe771b308d5787e >>>5b70%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636547406449130871&sda >>>ta=csv29dcqhaEqGECe5EogEtI%2F6YYiPlh9zzAqkQfCp%2Fk%3D&reserved=0>%7C50a4 >>>e8f572da47 >>> >>>4086c808d57867f756%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C63654731 >>>02 >>> >>>80500614&sdata=0iB06Uoq8M3Nj%2BMViiIB9AZqxEdIVSKkSKBuDurNKt8%3D&reserved >>>=0 >>>> * >
