27 Nov
2012
27 Nov
'12
3:18 p.m.
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
* 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)
* 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. For
example for the email it could be:
"
The XWiki development team is proud to announce the availability of XWiki Enterprise
<version>.
You can download it here: http://www.xwiki.org/xwiki/bin/view/Main/Download
Make sure to review the release notes:
http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/ReleaseNotesXWiki<short version>
Thanks
-The XWiki dev team
"
* Put maven.xwiki.org:~/xwiki-release-scripts under Git and do a git reset before the ow2
step to be sure to have clean scripts
WDYT?
Thanks
-Vincent
27 Nov
27 Nov
3:57 p.m.
On Tue, Nov 27, 2012 at 3:18 PM, Vincent Massol <vincent(a)massol.net> 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
* 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)
* 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. For example for the email it could be:
"
The XWiki development team is proud to announce the availability of XWiki
Enterprise <version>.
You can download it here:
http://www.xwiki.org/xwiki/bin/view/Main/Download
Make sure to review the release notes:
http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/ReleaseNotesXWiki<short
version>
Thanks
-The XWiki dev team
"
* Put maven.xwiki.org:~/xwiki-release-scripts under Git and do a git
reset before the ow2 step to be sure to have clean scripts
I don't understand this part, they are in git.
WDYT?
Thanks
-Vincent
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs
--
Thomas Mortagne
4 p.m.
On Nov 27, 2012, at 3:57 PM, Thomas Mortagne <thomas.mortagne(a)xwiki.com> wrote:
On Tue, Nov 27, 2012 at 3:18 PM, Vincent Massol
<vincent(a)massol.net> wrote:
Yes they are in git but not on maven.xwiki.org
-Vincent
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
* 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)
* 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. For example for the email it could be:
"
The XWiki development team is proud to announce the availability of XWiki
Enterprise <version>.
You can download it here:
http://www.xwiki.org/xwiki/bin/view/Main/Download
Make sure to review the release notes:
http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/ReleaseNotesXWiki<short
version>
Thanks
-The XWiki dev team
"
* Put maven.xwiki.org:~/xwiki-release-scripts under Git and do a git
reset before the ow2 step to be sure to have clean scripts
I don't understand this part, they are in git. > WDYT?
>
> Thanks
> -Vincent
4:34 p.m.
On Tue, Nov 27, 2012 at 4:00 PM, Vincent Massol <vincent(a)massol.net> wrote:
On Nov 27, 2012, at 3:57 PM, Thomas Mortagne <thomas.mortagne(a)xwiki.com>
wrote:
Yes they are in git but not on maven.xwiki.org
I was talking about maven.xwiki.org.
~/xwiki-release-scripts is just a link in a sub folder of ~/xwiki-dev-tools
which is the root of the repository.
On Tue, Nov 27, 2012 at 3:18 PM, Vincent Massol
<vincent(a)massol.net>
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
>
> * 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)
>
> * 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. For example for the email it
could be:
> "
> The XWiki development team is proud to announce the availability of
XWiki
> Enterprise <version>.
>
> You can download it here:
> http://www.xwiki.org/xwiki/bin/view/Main/Download
>
> Make sure to review the release notes:
> http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/ReleaseNotesXWiki
<short
version>
Thanks
-The XWiki dev team
"
* Put maven.xwiki.org:~/xwiki-release-scripts under Git and do a git
reset before the ow2 step to be sure to have clean scripts
I don't understand this part, they are in git.
-Vincent
--
Thomas Mortagne
> WDYT?
>
> Thanks
> -Vincent
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs
4:45 p.m.
Hi,
On Tue, Nov 27, 2012 at 5:34 PM, Thomas Mortagne
<thomas.mortagne(a)xwiki.com>wrote;wrote:
On Tue, Nov 27, 2012 at 4:00 PM, Vincent Massol
<vincent(a)massol.net>
wrote:
That's valid only for agent-1, not maven.xwiki.org.
On maven.xwiki.org you just have an "xwiki-release-scripts" directory with
previous releasenotes.<version>.txt files and some release scripts (of
which we only use push-release.sh, which is also included in
xwiki-dev-tools/xwiki-release-scripts on git. We probably did not update
our process and documentation and kept using this desynchronized script.
Thanks,
Eduard
On Nov 27, 2012, at 3:57 PM, Thomas Mortagne <thomas.mortagne(a)xwiki.com>
wrote:
Yes they are in git but not on maven.xwiki.org
I was talking about maven.xwiki.org.
~/xwiki-release-scripts is just a link in a sub folder of ~/xwiki-dev-tools
which is the root of the repository.
On Tue, Nov 27, 2012 at 3:18 PM, Vincent Massol
<vincent(a)massol.net>
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
>
> * 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)
>
> * 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. For example for the email it
could be:
> "
> The XWiki development team is proud to announce the availability of
XWiki
> Enterprise <version>.
>
> You can download it here:
> http://www.xwiki.org/xwiki/bin/view/Main/Download
>
> Make sure to review the release notes:
> http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/ReleaseNotesXWiki
<short
version>
Thanks
-The XWiki dev team
"
* Put maven.xwiki.org:~/xwiki-release-scripts under Git and do a git
reset before the ow2 step to be sure to have clean scripts
I don't understand this part, they are in git.
-Vincent
--
Thomas Mortagne
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs
> WDYT?
>
> Thanks
> -Vincent
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs
4:52 p.m.
On Tue, Nov 27, 2012 at 4:45 PM, Eduard Moraru <enygma2002(a)gmail.com> wrote:
Hi,
On Tue, Nov 27, 2012 at 5:34 PM, Thomas Mortagne
<thomas.mortagne(a)xwiki.com>wrote;wrote:
I was talking about maven.xwiki.org.
~/xwiki-release-scripts is just a link in a sub folder of ~/xwiki-dev-tools
Indeed I understood it as agent-1 which is the main release server. Forgot
maven.xwiki.org was not the same.
On Tue, Nov 27, 2012 at 4:00 PM, Vincent Massol
<vincent(a)massol.net>
wrote:
>
> On Nov 27, 2012, at 3:57 PM, Thomas Mortagne <
thomas.mortagne(a)xwiki.com>
> wrote:
>
> > On Tue, Nov 27, 2012 at 3:18 PM, Vincent Massol <vincent(a)massol.net>
> 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
> >>
> >> * 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)
> >>
> >> * 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. For example for the email it could be:
> >> "
> >> The XWiki development team is proud to announce the availability of
> XWiki
> >> Enterprise <version>.
> >>
> >> You can download it here:
> >> http://www.xwiki.org/xwiki/bin/view/Main/Download
> >>
> >> Make sure to review the release notes:
> >> http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/ReleaseNotesXWiki
> <short
> >> version>
> >>
> >> Thanks
> >> -The XWiki dev team
> >> "
> >>
> >> * Put maven.xwiki.org:~/xwiki-release-scripts under Git and do a
git
> reset before the ow2 step to be sure to have clean
scripts
>
I don't understand this part, they are in git.
Yes they are in git but not on maven.xwiki.org
which is the root of the repository.
That's valid only for agent-1, not maven.xwiki.org.
On maven.xwiki.org you just have an "xwiki-release-scripts" directory with
previous releasenotes.<version>.txt files and some release scripts (of
which we only use push-release.sh, which is also included in
xwiki-dev-tools/xwiki-release-scripts on git. We probably did not update
our process and documentation and kept using this desynchronized script.
Thanks,
Eduard
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs
--
Thomas Mortagne
-Vincent
--
Thomas Mortagne
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs
> WDYT?
>
> Thanks
> -Vincent
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs
4:47 p.m.
+1 from my part, specially if it's not complicated to push the clirr maven
plugin improvements.
Thanks,
Eduard
On Tue, Nov 27, 2012 at 4:18 PM, Vincent Massol <vincent(a)massol.net> 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
* 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)
* 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. For example for the email it could be:
"
The XWiki development team is proud to announce the availability of XWiki
Enterprise <version>.
You can download it here:
http://www.xwiki.org/xwiki/bin/view/Main/Download
Make sure to review the release notes:
http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/ReleaseNotesXWiki<short
version>
Thanks
-The XWiki dev team
"
* Put maven.xwiki.org:~/xwiki-release-scripts under Git and do a git
reset before the ow2 step to be sure to have clean scripts
WDYT?
Thanks
-Vincent
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs
10:01 p.m.
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.
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.
Why do you need to use the purl.org UI? The push-release script is
supposed to handle that automatically.
* 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. 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.
For example for the email it could be:
"
The XWiki development team is proud to announce the availability of XWiki Enterprise
<version>.
You can download it here: http://www.xwiki.org/xwiki/bin/view/Main/Download
Make sure to review the release notes:
http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/ReleaseNotesXWiki<short version>
Thanks
-The XWiki dev team
"
* Put maven.xwiki.org:~/xwiki-release-scripts under Git and do a git reset before the ow2
step to be sure to have clean scripts
I wanted to do that but git was not installed on the machine at that
time. I see that it is now.
[Some time later]
I did this, committed the only changes that were present there. It's a
read-only clone, so committing won't work directly from the machine
unless extra steps are taken.
WDYT?
Thanks
-Vincent
--
Sergiu Dumitriu
http://purl.org/net/sergiu
10:28 p.m.
Hi Sergiu,
On Nov 27, 2012, at 10:01 PM, Sergiu Dumitriu <sergiu(a)xwiki.org> wrote:
The summary is already in the release notes...
Great thanks!
-Vincent
On 11/27/2012 09:18 AM, Vincent Massol wrote:
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).
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. 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#HAnnounceo…
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. 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.
Having a one line sentence about the release is detrimental IMO (and more time consuming
for us when doing the release). We want people to click on the link and get to the
release notes page.
For example
for the email it could be:
"
The XWiki development team is proud to announce the availability of XWiki Enterprise
<version>.
You can download it here: http://www.xwiki.org/xwiki/bin/view/Main/Download
Make sure to review the release notes:
http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/ReleaseNotesXWiki<short version>
Thanks
-The XWiki dev team
"
* Put maven.xwiki.org:~/xwiki-release-scripts under Git and do a git reset before the ow2
step to be sure to have clean scripts
I wanted to do that but git was not installed on the machine at that
time. I see that it is now.
[Some time later]
I did this, committed the only changes that were present there. It's a
read-only clone, so committing won't work directly from the machine
unless extra steps are taken. > WDYT?
>
> Thanks
> -Vincent
28 Nov
28 Nov
1:07 a.m.
On 11/27/2012 04:28 PM, Vincent Massol wrote:
The summary is already in the release notes...
What kind of summary takes up 16 pages? That's how long is the PDF for
the 4.3 release notes.
Great thanks!
-Vincent
--
Sergiu Dumitriu
http://purl.org/net/sergiu
Hi Sergiu,
On Nov 27, 2012, at 10:01 PM, Sergiu Dumitriu <sergiu(a)xwiki.org> wrote:
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).
On 11/27/2012 09:18 AM, Vincent Massol wrote:
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). 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. 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#HAnnounceo…
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. 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. Having a one line sentence about the release is
detrimental IMO (and more time consuming for us when doing the release).
Time consuming? Such a summary is already present at the top of the
release notes; worst case, if the RM is lazy enough, he can just copy it
from there.
We want people to click on the link and get to the
release notes page.
"We want to *force* people to click on that link and spend several
minutes to read our nice release notes."
It's never a good idea to force people to do things, even if its for
their own good. You're hoping that the result will be "more readers of
the release notes", but the more likely outcome is the opposite. Only
people that are really interested in finding out what's new will
actually come and read the full release notes, and they will do that
regardless of whether a short summary is present in the email, tweet,
OW2 or FreeCode announcement or whatever.
I see two main benefits in a summary:
- readers will at least glance over the very short summary and have some
idea about what's going on
- some readers will find something that will catch their interest and
will want to find out more details, thus they'll open the release notes
We might even get new users if there's an interesting item in there.
Believing that everybody will want to read the full release notes is
wishful thinking.
I speak from my own experience. I only read the full release notes for
projects that are important for us and that I have some experience with:
Velocity and FOP. For everything else, I just read the announcement
emails or summaries published on LWN or The H.
So, the summary is not for people that are really attached to XWiki,
it's for casual news readers that might see the XWiki announcements
among other news.
For example for the email it could be:
"
The XWiki development team is proud to announce the availability of XWiki Enterprise
<version>.
You can download it here: http://www.xwiki.org/xwiki/bin/view/Main/Download
Make sure to review the release notes:
http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/ReleaseNotesXWiki<short version>
Thanks
-The XWiki dev team
"
* Put maven.xwiki.org:~/xwiki-release-scripts under Git and do a git reset before the ow2
step to be sure to have clean scripts
I wanted to do that but git was not installed on the machine at that
time. I see that it is now.
[Some time later]
I did this, committed the only changes that were present there. It's a
read-only clone, so committing won't work directly from the machine
unless extra steps are taken. > WDYT?
>
> Thanks
> -Vincent
9:16 a.m.
On Nov 28, 2012, at 1:07 AM, Sergiu Dumitriu <sergiu(a)xwiki.org> wrote:
On 11/27/2012 04:28 PM, Vincent Massol wrote:
Yes PURLs could be a good solution for specific important pages like the one you mention
but they are adhoc and I don't believe those are required for temporary resources such
as Release notes.
Or you really need to make it transparent so that it doesn't cost more when doing
releases. I spent 15 minutes trying to create a PURL when I did the release 2 days ago and
in the end I didn't do it since it was too complex and I couldn't understand how
to do it.
[snip]
Thanks
-Vincent
Hi Sergiu,
On Nov 27, 2012, at 10:01 PM, Sergiu Dumitriu <sergiu(a)xwiki.org> wrote:
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). On 11/27/2012 09:18 AM, Vincent Massol wrote:
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). 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. 
1:30 p.m.
On 11/28/2012 03:16 AM, Vincent Massol wrote:
On Nov 28, 2012, at 1:07 AM, Sergiu Dumitriu <sergiu(a)xwiki.org> wrote:
PURL is a really neat idea, there are multiple PURL servers and as I
understand it a URL is gossuped around similar to how PGP keyservers work
making it highly stable, decentralized and disaster resistant.
That said, in this case we're using it as a tinyurl clone and the average
viewer of a release tweet doesn't know what it is and of course twitter
insists on shortening everything with t.co so they can spy on people so
it's just another layer of indirection and an extra 250ms of wait time.
+1 to remove it from the tweet and the release process since it's extra
work and it doesn't even showcase the great technology that PURL is.
Thanks,
Caleb
On 11/27/2012 04:28 PM, Vincent Massol wrote:
Yes PURLs could be a good solution for specific important pages like the one you mention
but they are adhoc and I don't believe those are required for temporary resources such
as Release notes.
Or you really need to make it transparent so that it doesn't cost more when doing
releases. I spent 15 minutes trying to create a PURL when I did the release 2 days ago and
in the end I didn't do it since it was too complex and I couldn't understand how
to do it.
Hi Sergiu,
On Nov 27, 2012, at 10:01 PM, Sergiu Dumitriu <sergiu(a)xwiki.org> wrote:
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). 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). [snip]
Thanks
-Vincent
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs
9:51 a.m.
On Nov 28, 2012, at 1:07 AM, Sergiu Dumitriu <sergiu(a)xwiki.org> wrote:
On 11/27/2012 04:28 PM, Vincent Massol wrote:
The summary is already in the release notes...
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
Hi Sergiu,
On Nov 27, 2012, at 10:01 PM, Sergiu Dumitriu <sergiu(a)xwiki.org> wrote:
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).
On 11/27/2012 09:18 AM, Vincent Massol wrote:
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). 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. 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#HAnnounceo…
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. 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.
1:41 p.m.
Hi,
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
* 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)
* 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. For
example for the email it could be:
"
The XWiki development team is proud to announce the availability of XWiki Enterprise
<version>.
You can download it here: http://www.xwiki.org/xwiki/bin/view/Main/Download
Make sure to review the release notes:
http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/ReleaseNotesXWiki<short version>
Thanks
-The XWiki dev team
"
* Put maven.xwiki.org:~/xwiki-release-scripts under Git and do a git reset before the ow2
step to be sure to have clean scripts
As far as I understand, the scripts are in a git repo already, at any rate there
are so many things which can go wrong along the way that I think we'll always have
to give the RM a lot of latitude to make decisions, including to modify the scripts
during a release.
In general +1 to everything.
Thanks,
Caleb
WDYT?
Thanks
-Vincent
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs
4310
days inactive
4311
days old
13 comments
5 participants
participants (5)
-
Caleb James DeLisle -
Eduard Moraru -
Sergiu Dumitriu -
Thomas Mortagne -
Vincent Massol