8,560
edits
Release plan: Difference between revisions
no edit summary
(Moved lessons learned to Release plan/Lessons learned. as these lessons are not part of the release plan (yet).) |
No edit summary |
||
| Line 11: | Line 11: | ||
New FlightGear releases are scheduled twice a year. The magic number to remember is 17 (we tried 42, but that didn't turn out so well. 17 is perfect: 1 is not a prime, 7 is a prime and so is 17). On the 17th of January (1) and July (7) a new release branch is created for [[SimGear]], FlightGear and FGDATA. | New FlightGear releases are scheduled twice a year. The magic number to remember is 17 (we tried 42, but that didn't turn out so well. 17 is perfect: 1 is not a prime, 7 is a prime and so is 17). On the 17th of January (1) and July (7) a new release branch is created for [[SimGear]], FlightGear and FGDATA. | ||
{{cquote|As a clarification: We do not enter a code freeze but a feature freeze. Code changes are welcome after December 17th as long as it is guaranteed (not just "unlikely") that they do not introduce any side effects and become a release blocker. It is the sole responsibility of the commiter to decide if that is the case or not. Every new feature that didn't make it into the respository by the deadline may probably easily wait for another four weeks to get commited. Remember: most aircraft are not affected by the feature freeze and aircraft developers quickly adopt and use new features as they become available<ref>{{cite web |url=http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg38749.html|title=<nowiki>[Flightgear-devel] Next FlightGear release (Feb. 17 2013)</nowiki>|author=Torsten Dreyer|date= | {{cquote|As a clarification: We do not enter a code freeze but a feature freeze. Code changes are welcome after December 17th as long as it is guaranteed (not just "unlikely") that they do not introduce any side effects and become a release blocker. It is the sole responsibility of the commiter to decide if that is the case or not. Every new feature that didn't make it into the respository by the deadline may probably easily wait for another four weeks to get commited. Remember: most aircraft are not affected by the feature freeze and aircraft developers quickly adopt and use new features as they become available<ref>{{cite web |url=http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg38749.html|title=<nowiki>[Flightgear-devel] Next FlightGear release (Feb. 17 2013)</nowiki>|author=Torsten Dreyer|date=16 November 2012}}</ref>|Torsten Dreyer}} | ||
After branching, there is one month for bug fixing in the release branch, so building and packing of the binaries and FGDATA takes place around February, 18th and August, 18th. Allowing a few days for distribution of the files, new versions should be publically available around the 20th of February and August. | After branching, there is one month for bug fixing in the release branch, so building and packing of the binaries and FGDATA takes place around February, 18th and August, 18th. Allowing a few days for distribution of the files, new versions should be publically available around the 20th of February and August. | ||
| Line 36: | Line 36: | ||
##Commit the new version number to next (flightgear+simgear) and master(fgdata) | ##Commit the new version number to next (flightgear+simgear) and master(fgdata) | ||
##Tag (annotated) flightgear, simgear and fgdata with <tt>version/3.0.0</tt> | ##Tag (annotated) flightgear, simgear and fgdata with <tt>version/3.0.0</tt> | ||
##: | ##:<code>git tag -a version/3.0.0</code> (Enter a wise comment) | ||
##Push the branches next/master '''and''' the tags upstream | ##Push the branches next/master '''and''' the tags upstream | ||
##:for flightgear and simgear: | ##:for flightgear and simgear: <code>git push origin next</code> | ||
##:for fgdata: | ##:for fgdata: <code>git push origin master<code> | ||
##:for the tags (all repos): | ##:for the tags (all repos): <code>git push origin version/3.0.0</code> | ||
# '''Jan/Jul 17th:''' Create new release branch, assign new version number to dev-stream, re-open streams | # '''Jan/Jul 17th:''' Create new release branch, assign new version number to dev-stream, re-open streams | ||
<!-- We don't really need this step... | <!-- We don't really need this step... | ||
| Line 49: | Line 49: | ||
--> | --> | ||
##Pull current Git, create the release branches (for sg/fg/fgdata): | ##Pull current Git, create the release branches (for sg/fg/fgdata): | ||
##: | ##:<code>git pull</code> | ||
##: | ##:<code>git branch release/3.0.0</code> | ||
##On the next/master branches, bump up the version-number of simgear, flightgear and fgdata to an odd number (3.0.0 -> 3.1.0) | ##On the next/master branches, bump up the version-number of simgear, flightgear and fgdata to an odd number (3.0.0 -> 3.1.0) | ||
##Compile and test drive FlightGear with the new development version number | ##Compile and test drive FlightGear with the new development version number | ||
##Commit the changes of version-number to next/master | ##Commit the changes of version-number to next/master | ||
##Tag (annotated) flightgear, simgear and fgdata with "version/2.9.0" | ##Tag (annotated) flightgear, simgear and fgdata with "version/2.9.0" | ||
##: | ##:<code>git tag -a version/2.9.0</code> (Enter a wise comment) | ||
##Push the branches next/master '''and''' release/3.0.0 '''and''' the tags upstream | ##Push the branches next/master '''and''' release/3.0.0 '''and''' the tags upstream | ||
##:for flightgear, simgear and fgdata: | ##:for flightgear, simgear and fgdata: <code>git push origin release/3.0.0</code> | ||
##:for flightgear and simgear: | ##:for flightgear and simgear: <code>git push origin next</code> | ||
##:for fgdata: | ##:for fgdata: <code>git push origin master</code> | ||
##:for the tags (all repos): | ##:for the tags (all repos): <code>git push origin version/3.1.0</code> | ||
##Declare dev-streams "open" or "green" | ##Declare dev-streams "open" or "green" | ||
##: Ask a [http://wiki.flightgear.org/index.php?title=Special:ListUsers&group=sysop wiki admin] to change the content of wiki template at [[Template:GitStatus]] to <code><nowiki>{{GitStatus:open}}</nowiki></code> | ##: Ask a [http://wiki.flightgear.org/index.php?title=Special:ListUsers&group=sysop wiki admin] to change the content of wiki template at [[Template:GitStatus]] to <code><nowiki>{{GitStatus:open}}</nowiki></code> | ||
| Line 69: | Line 69: | ||
## Generate latest '''getstart.pdf''', push the PDF to fgdata/master - and cherry-pick to the '''release branch'''. Generate latest '''getstart''' HTML, push PDF and HTML to the MapServer site. | ## Generate latest '''getstart.pdf''', push the PDF to fgdata/master - and cherry-pick to the '''release branch'''. Generate latest '''getstart''' HTML, push PDF and HTML to the MapServer site. | ||
##Tag the release/3.00 branches of simgear, flightgear and fgdata and push the tags. | ##Tag the release/3.00 branches of simgear, flightgear and fgdata and push the tags. | ||
##:for flighgear, simgear and fgdata: | ##:for flighgear, simgear and fgdata: <code>git tag version/3.0.0-final</code> | ||
##:for flighgear, simgear and fgdata: | ##:for flighgear, simgear and fgdata: <code>git push origin version/3.0.0-final</code> | ||
##Merge the branch release/3.0.0 into '''master''' (<u>'''NOT'''</u> next) for flightgear and simgear and push the branch | ##Merge the branch release/3.0.0 into '''master''' (<u>'''NOT'''</u> next) for flightgear and simgear and push the branch | ||
##:We don't have a next branch for fgdata, no merging of the release branch here. | ##:We don't have a next branch for fgdata, no merging of the release branch here. | ||
##:for flighgear and simgear: | ##:for flighgear and simgear: | ||
##: | ##:<code>git checkout -b master origin/master</code> or <code>git checkout master</code> if you already have the local branch | ||
##: | ##:<code>git merge version/3.0.0-final</code> | ||
##: | ##:<code>git push origin master</code> | ||
##[[:Category:FlightGear Core developers|Core developers]] and other contributors should be invited to add their release related experiences (i.e. suggestions for improvements) to the wiki to help update and improve the release plan (i.e. this page) accordingly. | ##[[:Category:FlightGear Core developers|Core developers]] and other contributors should be invited to add their release related experiences (i.e. suggestions for improvements) to the wiki to help update and improve the release plan (i.e. this page) accordingly. | ||
| Line 118: | Line 118: | ||
The [http://flightgear-bugs.googlecode.com bugtracker] will be our primary source for the bug fixing period. Bugs reported on the mailing list or forum will not be tracked! Reporters shall be requested to file a bug report at the bugtracker. Bugs shall be assigned a priority and a keyword to make the assignment to a developer easier. Bug reports that can't be confirmed or need more input from the reporter to get fixed will be assigned a new state "stalled" and only processed after more information has been provided. Bugs assigned a high priority will be downgraded, if no progress has been made over a certain amount of time. This is to prevent the release from being blocked by a bug that no developer is able (or willing) to fix. The only exception is "does not compile for one of the major platforms", which certainly is a release-blocker. | The [http://flightgear-bugs.googlecode.com bugtracker] will be our primary source for the bug fixing period. Bugs reported on the mailing list or forum will not be tracked! Reporters shall be requested to file a bug report at the bugtracker. Bugs shall be assigned a priority and a keyword to make the assignment to a developer easier. Bug reports that can't be confirmed or need more input from the reporter to get fixed will be assigned a new state "stalled" and only processed after more information has been provided. Bugs assigned a high priority will be downgraded, if no progress has been made over a certain amount of time. This is to prevent the release from being blocked by a bug that no developer is able (or willing) to fix. The only exception is "does not compile for one of the major platforms", which certainly is a release-blocker. | ||
Bugs that were present in the latest stable release, and now considered "fixed", should be assigned a milestone label, corresponding with the upcoming stable release number. By doing so, they'll end up in [http://code.google.com/p/flightgear-bugs/issues/list?can=1&q=label%3AMilestone-2. | Bugs that were present in the latest stable release, and now considered "fixed", should be assigned a milestone label, corresponding with the upcoming stable release number. By doing so, they'll end up in [http://code.google.com/p/flightgear-bugs/issues/list?can=1&q=label%3AMilestone-2.12.0 the list of fixed bugs]. | ||
=== Tasks and owners === | === Tasks and owners === | ||
| Line 128: | Line 128: | ||
! width="500px" | Task | ! width="500px" | Task | ||
! Owner(s) | ! Owner(s) | ||
! Status for [[Changelog 2. | ! Status for [[Changelog 2.12|2.12]] | ||
|- | |- | ||
! rowspan="7" | | ! rowspan="7" | | ||
| Announce the state-change of the dev-streams | | Announce the state-change of the dev-streams | ||
| TorstenD | | TorstenD | ||
| | | | ||
|- | |- | ||
| Create/maintain the git branches | | Create/maintain the git branches | ||
| TorstenD | | TorstenD | ||
| | | | ||
|- | |- | ||
| Track the bugs on the tracker, trigger developers, adjust bug-priorities | | Track the bugs on the tracker, trigger developers, adjust bug-priorities | ||
| Line 144: | Line 144: | ||
| Sync the language files so they can be translated | | Sync the language files so they can be translated | ||
| ThorstenB, James | | ThorstenB, James | ||
| | | | ||
|- | |- | ||
| Beta testing | | Beta testing | ||
| Line 151: | Line 151: | ||
| Update documentation: [[FAQ]], [https://www.gitorious.org/fg/getstart/ The Manual], wiki | | Update documentation: [[FAQ]], [https://www.gitorious.org/fg/getstart/ The Manual], wiki | ||
| Stuart, Gijs and anyone else | | Stuart, Gijs and anyone else | ||
| | | | ||
|- | |- | ||
| Pack RC and final version of FGDATA | | Pack RC and final version of FGDATA | ||
| Line 165: | Line 165: | ||
| Windows | | Windows | ||
| Curt | | Curt | ||
| | | | ||
|- | |- | ||
| MacOS | | MacOS | ||
| Tat/James | | Tat/James | ||
| | | | ||
|- | |- | ||
| Distribute files to download servers | | Distribute files to download servers | ||
| Curt | | Curt | ||
| | | | ||
|- | |- | ||
! rowspan="3" | Make adjustments on the web-site | ! rowspan="3" | Make adjustments on the web-site | ||
| Line 196: | Line 196: | ||
== Open items, questions == | == Open items, questions == | ||
* Automate and/or document the creation of RC's: "We need to get this automated some day. Or at least documented...(another one from "famous last words": if you have to do it more than once, automate it. If you can't automate it, document it." | * Automate and/or document the creation of RC's: "We need to get this automated some day. Or at least documented...(another one from "famous last words": if you have to do it more than once, automate it. If you can't automate it, document it."<ref>{{Cite web |url=http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg39205.html |title=<nowiki>Re: [Flightgear-devel] Release candidates</nowiki> |author=Torsten Dreyer |date=29 January 2013}}</ref> | ||
* Automate the creation of Windows and Mac installers | * Automate the creation of Windows and Mac installers | ||
* Automate the creation of FGDATA distribution | * Automate the creation of FGDATA distribution | ||
* Possibly try to find a way to automate testing of updated jsbsim code, so that the chance for breakage is reduced by running scripted tests | * Possibly try to find a way to automate testing of updated jsbsim code, so that the chance for breakage is reduced by running scripted tests <ref>{{Cite web |url=http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg39109.html |title=<nowiki>Re: [Flightgear-devel] [Jsbsim-devel] JSBSim Synch with FlightGear</nowiki> |author=Torsten Dreyer |date=13 January 2013}}</ref><ref>{{Cite web |url=http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg40201.html |title=<nowiki>Re: [Flightgear-devel] JSBSim Synch with FlightGear</nowiki> |author=Anders Gidenstam |date=11 June 2013}}</ref> | ||
== Lessons learned == | == Lessons learned == | ||