On Nov 28, 2012, at 1:07 AM, Sergiu Dumitriu <[email protected]> wrote:
> On 11/27/2012 04:28 PM, Vincent Massol wrote: >> Hi Sergiu, >> >> On Nov 27, 2012, at 10:01 PM, Sergiu Dumitriu <[email protected]> wrote: >> >>> On 11/27/2012 09:18 AM, Vincent Massol wrote: >>>> Hi devs, >>>> >>>> Here are some notes I took while releasing XWiki 4.3 on how to improve the >>>> release process: >>>> >>>> * We need to automate the generation of the CLIRR report. This is what >>>> takes the longest when releasing (not overall time but manual time >>>> required). IMO this can be done relatively easily by creating a patch for >>>> the CLIRR maven plugin itself to: >>>> ** Add support for wildcards in the new <difference> syntax >>>> ** Ensure that their report generation takes into account the >>>> <justification> element >>>> ** Possibly add a text report generation that we'll be able to copy paste >>>> in our RN >>> >>> +1. >>> >>>> * Remove PURL generation for Tweets >>>> ** Tweets are ephemeral so no need to have permanent URLs >>>> ** Tweet clients already do URL shortening >>>> (It's complex to use the PURL UI too) >>> >>> -1. The PURL is not just about twits, it's about having some permanent >>> links to our release notes. I really don't like that our URLs are so >>> damn long >>> (http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/ReleaseNotesXWiki44RC1 >>> is 71 chars long), so I like to have something shorter. >> >> You don't need PURL for that…. As i mentioned the tweet clients already >> shorten URLs… Check my tweet, you'll see it's not 71 chars long: >> https://twitter.com/xwikiorg/status/273180659521028096 (I didn't do anything >> specific to shorten the URL). > > Again, this is not about tweeter. PURLs aren't about length, they're > about finding something in a reliable place, and involve maintenance > work. There should be no broken PURL. I created a few other PURLs a long > time ago, like purl.org/xwiki/repo/, purl.org/xwiki/ml/ and > purl.org/xwiki/ml/archive, purl.org/xwiki/ci/ (which used to point to > hudson). > >>> So far I seem to be the only one that sees the value of PURLs, so if you >>> think that we don't want to maintain them in general (not just because >>> tweets are ephemeral), we could do that. >> >> They could have value in other places than tweets but then we don't do this >> for a lot more things like install documentation, download page, etc and >> those are way more important than release notes which are also very >> ephemeral. So my take is to drop them for release notes links. >> >>> Why do you need to use the purl.org UI? The push-release script is >>> supposed to handle that automatically. >> >> Check the documentation at >> http://dev.xwiki.org/xwiki/bin/view/ReleasePlans/ReleasePlanHelp#HAnnounceonTwitter >> It says not to use it. >> >>> >>>> * Don't create RN summary for OW2, email and even blog post. This will win >>>> some more time. Instead just link to the RN page which contains a summary >>>> and all details. >>> >>> I'm kind of -1 for this as well. The summary is for lazy or busy people >>> that don't have time to read our lengthy release notes. >> >> The summary is already in the release notes... >> >>> Not even our own >>> devs (and the rest of the XWiki SAS employees) have time to read them >>> fully. A very quick summary that takes 30 seconds to read is a good >>> thing, at least a few more people will find the time to read those and >>> notice how XWiki evolves. >> >> The release notes ARE are summary. We take a lot of pain to make them nice >> looking and readable. > > What kind of summary takes up 16 pages? That's how long is the PDF for > the 4.3 release notes. [snip] Ok I have a solution that will make both of us happy: * I plan to create the Release Application. It'll include the ability to create release notes (I want to be able to autogenerate the final release notes from the M1, M2, RC1, etc) and I'll put a summary field that will be displayed at the top of the release notes in view mode. We will then be able to update the release scripts to automatically get the summary from them, thus not breaking the automated release process and not loosing time. We'll also be able to fully autogenerate the email with this. Thanks -Vincent _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
