To summarize:
Pros and cons of automatic:
+ Not missing any
- Technical descriptions
Pros and cons of manual:
+ Nice hand-made messages
- Usually missing some, unless we add a process (like have the RM ensure that none are
missing the previous release notes)
WDYT?
Thanks
-Vincent
On 13 Nov 2015 at 17:56:00, vincent(a)massol.net (vincent(a)massol.net) wrote:
OTOH if we do it automatically we won’t have as nice description as what we can have when
we hand-make them. For example
on
http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/ReleaseNotesXWiki71 we have:
“
This release introduces a bug concerning the upgrade of the subwikis
([[
XWIKI-12208>>http://jira.xwiki.org/browse/XWIKI-12208]])208]]). You can still upgrade
them via Distribution Wizard but only at the same time you upgrade the main wiki. You can
also upgrade your subwiki's UI like any other extensions, by clicking on "Check
for updates".
The best is to wait for the release of 7.1.1 which will fix this problem and should be
ready really soon.
"
And if we use the strategy below we get:
https://www.evernote.com/l/AHfEQXsj4mNH4pjXgxuiL4uZiomR5kUpkpA
As you can see on the screenshot if we do it manually we’re missing a lot of blocker
issues.
WDYT?
Thanks
-Vincent
On 13 Nov 2015 at 17:51:50, vincent(a)massol.net (vincent(a)massol.net) wrote:
Hi devs,
I’d like to suggest a new best practice which would consist in systematically adding
blockers issues in the release notes corresponding to the affects versions, at the top,
using an error macro. For example I’ve updated the release notes for 7.2 and 7.3:
-
http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/ReleaseNotesXWiki72
-
http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/ReleaseNotesXWiki73
The idea would be to update our Release Notes template to automatically list them using
this template snippet (example for XWiki 7.2):
"
{{error}}
The following blocking issues were found after this version was released. You should
verify if you're using the affected features and if so, you can click on them to see
in which version they are fixed):
{{jira url="http://jira.xwiki.org" style="list"
source="jql"}}
category = "Top Level Projects" and affectedVersion in
("7.2-milestone-1", "7.2-milestone-2", "7.2-milestone-3",
"7.2-rc-1", "7.2") and fixVersion > "7.2" and priority =
Blocker and resolution = Fixed
{{/jira}}
{{/error}}
“
The goal is to make it easy for our end users to see blocking issues in a given release.
The goal is also to make it visible to us how many blockers we introduce in each release
and work on reducing this number as much as possible.
WDYT?
Thanks
-Vincent
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs