Hi fellow wiki editors!

To help newly registered users get more familiar with the wiki (and maybe older users too) there is now a {{Welcome to the wiki}} template. Have a look at it and feel free to add it to new users discussion pages (and perhaps your own).

I have tried to keep the template short, but meaningful. /Johan G

Difference between revisions of "Release plan"

From FlightGear wiki
Jump to: navigation, search
(2.10)
 
(135 intermediate revisions by 13 users not shown)
Line 1: Line 1:
 
{{GitStatus}}
 
{{GitStatus}}
 +
{{Release}}
  
This page contains details about how to release a new version of [[FlightGear]] into the wild. It is a continous work in progress to be improved with every new release.  
+
The '''release plan''' is the process by which a new version of [[FlightGear]] is released. The release plan is actually a continual work-in-progress, and is refined with every new release.
  
[[File:ReleasePlan.jpg|thumb|250px|The original plan]]
+
[[File:ReleasePlan.jpg|thumb|250px|The original release plan.]]
This '''release plan''' was originally developed by Mathias Fröhlich, Martin Spott, Thorsten Brehm and Torsten Dreyer during LinuxTag 2011.
+
FlightGear has had two release plans over [[FlightGear History|history]]. The original release plan was developed by Mathias Fröhlich, Martin Spott, Thorsten Brehm and Torsten Dreyer during LinuxTag 2011. The current plan was proposed by Torsten Dreyer after the 3.6 release was [[FlightGear Newsletter November 2015#FlightGear v3.6 canceled|cancelled]].
  
If you think you have something to contribute to the release process, feel free to <span class=plainlinks>[{{SERVER}}{{localurl:{{NAMESPACE}}:{{PAGENAME}}|action=edit}} edit this page]</span>. In particular, improvements should be based on [[Release plan#Lessons learned]] from past releases. Please discuss this concept at the mailing-list.
+
To suggest improvements and/or changes to the release plan, it is recommended to get in touch via the [[mailing list]]. Improvements can be based on the [[Release plan/Lessons learned|lessons learned]] from previous releases.
  
=== General release concept ===
+
== General release concept ==
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.  
+
A new version of FlightGear is released every three months, meaning four releases per year. On the 17th of the month, new release branches are created and the [[build server]] creates the binaries and uploading them to SourceForge. If any changes are made to the release branch, a new bugfix release is created. The version of the <code>next</code> branch is incremented. And development coninutes as normal, with new nightly builds be created after each change. The table below shows the release cycle. See also [http://sourceforge.net/p/flightgear/mailman/message/34701971/ this mailing list post].
  
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.
+
{| class="wikitable"
 +
! Month !! Number in cycle
 +
|-
 +
| January
 +
| style="background-color: #e55757" | 4 ''(previous year)''
 +
|-
 +
| February
 +
| style="background-color: #e4ae3a" | 1
 +
|-
 +
| March
 +
| style="background-color: #e4ae3a" | 1
 +
|-
 +
| April
 +
| style="background-color: #e4ae3a" | 1
 +
|-
 +
| May
 +
| style="background-color: #6a6bd7" | 2
 +
|-
 +
| June
 +
| style="background-color: #6a6bd7" | 2
 +
|-
 +
| July
 +
| style="background-color: #6a6bd7" | 2
 +
|-
 +
| August
 +
| style="background-color: #63e557" | 3
 +
|-
 +
| September
 +
| style="background-color: #63e557" | 3
 +
|-
 +
| October
 +
| style="background-color: #63e557" | 3
 +
|-
 +
| November
 +
| style="background-color: #e55757" | 4
 +
|-
 +
| December
 +
| style="background-color: #e55757" | 4
 +
|}
  
The development stream of SimGear, FlightGear and FGDATA is set into a frozen state one month before the branch-day (17th), to let the dust of development settle and to allow fixing the most annoying bugs in the code. During this period, developers should not add any new features, subsystems, and the like. Immediately after the stream has branched for the release, development in the main stream (next/master) is open for major changes until one month before the next branch-day. This results in a duty cycle of 5 month developing and 1 month thinking.
+
== Version numbers ==
 +
FlightGear version numbers consist of three digits, separated by dots:
  
=== Version numbers ===
+
=== Before 2016.1 ===
FlightGear version numbers exist of three digits, seperated by dots:
+
* '''Major''' (<u>3</u>.4.0): Only increased after significant changes to the functionality of the software (e.g., 1.x.x → 2.0.0 (due to switch to [[OSG]]).
* '''Major''' (<u>2</u>.4.1): is only increased after significant changes to the functionality of the software, i.e. 1.X.X => 2.0.0 (due to switch to OSG).
+
* '''Minor''' (3.<u>4</u>.0): Has two applications:
* '''Minor''' (2.<u>4</u>.1): has two applications:
+
** '''Stable releases''' always have ''even numbers'' (e.g. 2.8.0, 2.10.0, 2.12.0).
** '''Stable releases''' always have ''even numbers'', i.e. 2.6.0, 2.8.0, 3.0.0.
+
** The '''latest [[Git]] version''' or '''[[FlightGear build server|nightly build]]''' uses an ''odd number'', always one more than the latest stable release's minor revision numbere. For example, when the latest release was 3.4.0, the current development stream was 3.5.0.
** The '''development stream''' (''latest Git version'') uses an ''odd number'', increasing the minor number of the latest stable release's version by one. I.e., when the latest release is 2.8.0, the current development stream is 2.9.0.
+
* '''Revision''' (3.4.<u>0</u>): Increased by bugfix releases (e.g., 2.12.1).
* '''Revision''' (2.4.<u>1</u>): is increased by bugfix releases, i.e. 2.8.1, 2.8.2, 2.8.3.
+
  
=== Detailed time schedule and checklist ===
+
=== 2016.1 and after ===
# '''Dec/Jun 17th:''' Development stream is declared "frozen" or "yellow"
+
* '''Year''' (<u>2016</u>.1.0): The year the version was released.
##Send a mail to the flightgear-devel mailing-list to announce the state
+
* '''Number''' (2016.<u>1</u>.0): Which release of the year the version is (note: starts at 1).
##Create a "release preperations" topic at the forum and make it a "Global Announcement"
+
* '''Revision''' (2016.1.<u>0</u>): Indicates one of two things:
##Change the content of wiki template at [[Template:GitStatus]] to <code><nowiki>{{GitStatus:frozen}}</nowiki></code>
+
** In the '''latest [[Git]] version''' or '''[[FlightGear build server|nightly build]]''', this digit is 0, indicating that it is unstable.
##Bump up the version-number of simgear/next, flightgear/next and fgdata/master to an even number (2.9.0 -> 3.0.0)
+
** When a new '''release''' is created, this digit is set to 1. With bugfix that is made, this digit is increased by 1, and a new version created.
##modify options.cxx to bump the hard-coded base package version number in [http://gitorious.org/fg/flightgear/commit/bffb5589215182cb21ab2b2697ae7bf000db1412/diffs/ddc2a745c67d138b34e3d95948d341341c85965d]
+
##Compile and test drive FlightGear with the new version-number
+
##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>
+
##:''git tag -a version/3.0.0'' (Enter a wise comment)
+
##Push the branches next/master '''and''' the tags upstream
+
##:for flightgear and simgear: ''git push origin next''
+
##:for fgdata: ''git push origin master''
+
##:for the tags (all repos): ''git push origin version/3.0.0''
+
# '''Jan/Jul 17th:''' Create new release branch, assign new version number to dev-stream, re-open streams
+
<!-- We don't really need this step...
+
##Declare the streams "closed" or "red"
+
##:Send a mail to the flightgear-devel mail-list, asking not to commit/push anything
+
##:Post an update to the forum topic
+
##:Change the content of wiki template at [[Template:GitStatus]] to <code><nowiki>{{GitStatus:closed}}</nowiki></code>
+
-->
+
##Pull current Git, create the release branches (for sg/fg/fgdata):
+
##:''git pull
+
##:''git branch release/3.0.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
+
##Commit the changes of version-number to next/master
+
##Tag (annotated) flightgear, simgear and fgdata with "version/2.9.0"
+
##:''git tag -a version/2.9.0'' (Enter a wise comment)
+
##Push the branches next/master '''and''' release/3.0.0 '''and''' the tags upstream
+
##:for flightgear, simgear and fgdata: ''git push origin release/3.0.0''
+
##:for flightgear and simgear: ''git push origin next''
+
##:for fgdata: ''git push origin master''
+
##:for the tags (all repos): ''git push origin version/3.1.0''
+
##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>
+
##:Send a mail to the flightgear-devel mailing-list to announce the state.
+
## Trigger James for the Jenkins-builds and Curt for a snapshot release and ThorstenB for the OpenSuse build
+
# '''Feb/Aug 1st:''' Start preparing the release notes and a press announcement
+
# '''Feb/Aug 17th:''' Create binaries/installers, pack fgdata, publish files, announce new version, close the release-branch.
+
## 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.
+
##:for flighgear, simgear and fgdata: ''git tag version/3.0.0-final''
+
##:for flighgear, simgear and fgdata: ''git push origin version/3.0.0-final''
+
##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.
+
##:for flighgear and simgear:
+
##:''git checkout -b master origin/master'' or ''git checkout master'' if you already have the local branch
+
##:''git merge version/3.0.0-final
+
##:''git push origin master''
+
##[[: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.
+
  
=== To bump up the version number ===
+
{{note|In general, release are referred to by their first two digits (e.g., 3.4). However, when filing a bug report or debugging problems, it is a good idea to give the full release number.}}
* fgdata
+
** edit the ''version'' file
+
* SimGear
+
** edit the ''version'' file
+
* FlightGear
+
** edit the ''version'' file
+
  
=== Definition of repository states ===
+
== Detailed time schedule and checklist ==
{| class="wikitable"
+
# Just after the next release, the next default airport is decided on by a poll on the forum. The next release will be named after it.
!
+
# (On the 17th of the release month): The first Jenkins script is triggered to create <code>release/xxxx.x.0</code> branches with version xxxx.x.0.
! State
+
# Jenkins creates the binaries for xxxx.x.1.
! Description
+
# Patches going into the <code>release/xxxx.x.0</code> branch automatically trigger a new build with a increase of the revision version number (see [[#2016.1 and after|above]]) and we immediately have a bugfix release.
|-
+
# On the <code>next</code> branch, the version number is changed.
! [[File:Traffic light green.png|20px]]
+
# Nightly builds are created from <code>next</code> after every push in that branch.
! Open/Green
+
| Normal development of the code base and fgdata. Unrestricted (well, sort of) access to the streams. This state lasts for five month after the release branches were created.
+
|-
+
! [[File:Traffic light yellow.png|20px]]
+
! Frozen/Yellow
+
| No new features or major changes shall be pushed onto the development streams (neither source nor data). This period is for preparing the code for the release and make sure there are no major issues. It lasts for four weeks until creation of the release branches.
+
  
It's a good idea for aircraft developers to adhere to this rule. However, aircraft in fgdata may be handled as an exception from the frozen state. Any change to aircraft may be pushed to the repository if it is guaranteed that this change does not affect any other aircraft or system and if no file outside the root directory of that specific aircraft is changed. Also, aircraft defined as part of the base package (e.g. the c172p) enter the frozen state and shall not undergo major changes in that period.
+
The process is repeated after three months.
|-
+
! [[File:Traffic light red.png|20px]]
+
! Closed/Red
+
| Nothing shall be pushed to the development streams (simgear, flightgear and fgdata). This state is for creating the release branches. It lasts for just a few hours on Jan 17th and Jul 17th around 12:00 UTC.
+
|}
+
  
=== Bug fix committing policy ===
+
== Version files ==
 +
; FGData: {{fgdata file|version}}
 +
; SimGear: {{simgear file|version}}
 +
; FlightGear: {{flightgear file|version}}
 +
; FGRun: [http://sourceforge.net/p/flightgear/fgrun/ci/next/tree/version fgrun/version]
 +
<!--
 +
== Bug fix committing policy ==
 
Fixes for bugs during the shakedown test of the release branch may be applied to the branches next or release/2.8.0.
 
Fixes for bugs during the shakedown test of the release branch may be applied to the branches next or release/2.8.0.
 
A fix goes into release/2.8.0 if the development of next has moved forward and this fix does not apply there. It also goes into the release branch if there will be a better fix for next.  
 
A fix goes into release/2.8.0 if the development of next has moved forward and this fix does not apply there. It also goes into the release branch if there will be a better fix for next.  
Line 111: Line 93:
  
 
'''DO NOT''' merge next into release/2.8.0 or vice versa. Most likely, there will be commits that are not welcome in or even break the other branch.
 
'''DO NOT''' merge next into release/2.8.0 or vice versa. Most likely, there will be commits that are not welcome in or even break the other branch.
 +
-->
  
=== Bug tracking ===
+
== Bug tracking ==
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://sourceforge.net/p/flightgear/codetickets/ bugtracker] is the primary source of bug reports. Unlike the forum or mailing list, bugs reported there will be tracked, making it easier for developers to keep up with them. When reporting bugs, it is best to provide as much information as possible to more easily find the bug. If you can provide a backtrace, please do so and attach it to the bug report. When creating backtraces, please use "thread apply all bt full" at the gdb command prompt.
 
+
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.8.0 the list of fixed bugs].
+
  
 +
<!--
 
=== Tasks and owners ===
 
=== Tasks and owners ===
  
 
The following table should be updated and augmented after each release, according to the [[Release plan#Lessons learned|Lessons learned]] section below.
 
The following table should be updated and augmented after each release, according to the [[Release plan#Lessons learned|Lessons learned]] section below.
  
{|class="wikitable"
+
{| class="wikitable"
!
+
! Stage
 
! width="500px" | Task
 
! width="500px" | Task
 
! Owner(s)
 
! Owner(s)
! Status for [[Changelog 2.10.0|2.10.0]]
 
 
|-
 
|-
! rowspan="7" |  
+
! rowspan="7" | Preparation
| Announce the state-change of the dev-streams
+
| Announce the state-change of the dev-streams, '''cross-post to JSBSim list''' (see lessons learned!)
 
| TorstenD
 
| TorstenD
| {{Done}}
 
 
|-
 
|-
 
| Create/maintain the git branches
 
| Create/maintain the git branches
 
| TorstenD
 
| TorstenD
| {{Done}}
 
 
|-
 
|-
 
| Track the bugs on the tracker, trigger developers, adjust bug-priorities
 
| Track the bugs on the tracker, trigger developers, adjust bug-priorities
Line 141: Line 120:
 
| Sync the language files so they can be translated
 
| Sync the language files so they can be translated
 
| ThorstenB, James
 
| ThorstenB, James
| {{Done}}
 
 
|-
 
|-
 
| Beta testing  
 
| Beta testing  
Line 148: Line 126:
 
| 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
| {{Done}}
 
 
|-
 
|-
| Pack RC and final version of FGDATA
+
| Pack RC and final version of fgdata
 
|
 
|
 
|-
 
|-
Line 162: Line 139:
 
| Windows
 
| Windows
 
| Curt
 
| Curt
| {{Done}} [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg39219.html]
 
 
|-
 
|-
 
| MacOS
 
| MacOS
 
| Tat/James
 
| Tat/James
| {{Done}} [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg39221.html]
 
 
|-
 
|-
 
| Distribute files to download servers
 
| Distribute files to download servers
 
| Curt
 
| Curt
| {{progressbar|30}}
 
 
|-
 
|-
! rowspan="2" | Make adjustments on the web-site
+
! rowspan="3" | Make adjustments on the web-site
 
| Collect/make screenshots for the gallery  
 
| Collect/make screenshots for the gallery  
 
| Curt
 
| Curt
Line 178: Line 152:
 
| Generate aircraft page
 
| Generate aircraft page
 
| Curt, Gijs
 
| Curt, Gijs
 +
|-
 +
| Tag the [http://wiki.flightgear.org/index.php?title=Talk:Next_newsletter&action=edit&section=45 newsletter template] according to the released version
 +
<nowiki>[[Category:Changes after 2.12]]</nowiki>
 +
| Hooray, Gijs, Stuart (other wiki admins)
 
|-
 
|-
 
! rowspan="2" | Announce the new version to the public
 
! rowspan="2" | Announce the new version to the public
| Write a changelog: [[Changelog 3.0.0]]
+
| Write a changelog: [[Next changelog]]
| All developers
+
| All developers/contributors
 
|-
 
|-
| Contact flightsim websites and send them/link them to the "press announcement". See [[release promotion]] for a list of already-contacted and yet-to-contact websites/magazins.
+
| Contact flightsim websites and send them/link them to the "press announcement". See [[release promotion]] for a list of already-contacted and yet-to-contact websites/magazines.
 
| '''EVERYBODY'''
 
| '''EVERYBODY'''
 
|}
 
|}
  
=== 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." [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg39205.html]
+
* 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 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 <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><ref>
* 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 [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg39109.html]
+
{{Cite web |url=http://sourceforge.net/p/flightgear/mailman/message/31762085/
 +
|title=<nowiki>Release preparations - feature freeze starts today</nowiki> |author=Anders Gidenstam |date=2013-12-17 19:46:48}}
 +
</ref>
  
=== Lessons learned ===
+
-->
This is a list of lessons learned from the previous releases, things that turned out well and should be kept for the next release as well as thing that didn't turn out so well and should be changed for future releases. Ideally, the release plan should be updated and augmented so that the lessons learned are incorporated accordingly.
+
 
+
==== 2.10 ====
+
* '''FlightGear Core related ''':
+
** perform a sync with JSBSim sources before the feature freeze.
+
** there were a number of navcache/SQLite related issues reported via the issue tracker and the forum/devel list [https://code.google.com/p/flightgear-bugs/issues/detail?id=894] [http://flightgear.org/forums/viewtopic.php?f=68&p=175690#p175690]
+
** a little irritation/frustration was caused due to the conflicting review statements concerning the new radio propagation code [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg38905.html] [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg38825.html] [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg33692.html] - some of this boiled down to coding style related issues, highlighting the fact that different core developers have different "coding styles" and requirements when reviewing merge requests, because we still lack an official "FlightGear coding style guide" [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg38958.html]
+
 
+
 
+
* '''Changelog / Release Announcement''':
+
** {{Thumbs up}} Walking through the list of "lessons learned" as part of the "Upcoming release" announcement was useful [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg38749.html]
+
** Probably it would be even better to directly process all "lessons learned" items and improve the release plan after each release accordingly
+
** To get to the 3.0 goal sometime in the near future, it's probably a good  idea to [[FlightGear 3.0 backlog|create a backlog of open items in the wiki and link the release plan document to that]]. As usual, we don't have to be perfect for a new major release number. But the new features being the reason for the new major  number should work reasonably correct.  [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg38888.html] (also see [[:Category:Developer Plans]])
+
** {{Thumbs up}} Posting the link to the changelog for the upcoming release helped writing the changelog early, this should also be done for the [[Hardware Recommendations]] and [[Notebooks known to run FlightGear]] pages probably?
+
** {{Thumbs up}} The changelog can be easily written by using "git log", searching the issue tracker and by going through the last 6 newsletters published since the previous release. It might make sense to explicitly add a "ChangeLog" message to important commits, so that the Changelog can be compiled more easily ?
+
** Alternatively, request developers to add major changes also to $FG_SRC/ChangeLog again (last updated in 2001)?
+
** for the web-based release announcement, it would be helpful to have screen shots or even youtube videos to demonstrate new features
+
** it may make sense to also allow artwork contributors to contribute new splash screen images for use in the upcoming release. The screen shot contest should provide plenty of options [http://www.flightgear.org/forums/viewtopic.php?f=28&t=16795].
+
** The RC announcement should also contain links to 1) the issue tracker and 2) the RC subforum [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg39222.html]
+
** Using wiki tagging, we could ensure that we can also tag our wiki documentation after each release, so that we can provide older versions of our docs for old FG versions [http://flightgear.org/forums/viewtopic.php?f=3&t=18240&p=170735&hilit=wiki+tagging#p170735]
+
 
+
* '''Shaders''':
+
** {{Thumbs up}} lowering the default shader level to 1 improved compatibility for older/underpowered systems [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg39189.html]
+
** GLSL shaders and effects should be treated like core code, and should be tested on different platforms before being enabled by default (i.e. signed-off by people using NVIDIA, ATI/AMD, Intel) [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg39120.html]
+
** modified shaders should be tested with other shader-related features to prevent breakage [http://flightgear.org/forums/viewtopic.php?f=68&t=18924#p175583] (there might be a way to automate this a litle by catching GLSL compiler errors?)
+
** to address all the intel GPU related issues, we may want to show an info dialog on computers where /sim/rendering/gl-vendor contains "intel" as a substring and provide an option to disable all shaders [http://flightgear.org/forums/viewtopic.php?f=37&t=18050&p=175774#p175774]
+
 
+
* '''FGData related (Base Package)''':
+
** Language files should be synced between English and other languages, so translators can work on them before the release ;-)
+
** the [https://gitorious.org/fg/flightgear/blobs/next/scripts/python/nasal_api_doc.py nasal_api_doc.py] script in $FG_SRC/scripts/python should be run as part of the release process, to create an updated doc file for $FG_ROOT/Docs and ship it with each release [http://flightgear.org/forums/viewtopic.php?f=30&t=15133]
+
** New/updated Nasal scripts contributed to the base package should be checked to properly support important features like simulator reset, this also applies to Nasal scripts used by aircraft, Nasal scripts that fail these criteria, end up breaking existing features! [https://code.google.com/p/flightgear-bugs/issues/detail?id=956] (also see [[Release:Aircraft Selection Criteria]])
+
** {{Thumbs up}} regarding aircraft included in the release: "I must stress usefulness of the Autostart feature, present in most aircraft not running at startup. It keeps frustration away from those who just want to enjoy the flight . (Please note that I actually agree with aircraft being shut down at startup, as long as autostart is present, or the starting procedure is trivially doable by just trying what you see in the cockpit.) " [http://flightgear.org/forums/viewtopic.php?f=3&t=18240&p=175117#p175117] (also see [[Release:Aircraft Selection Criteria]])
+
** {{Thumbs up}} also, it would apparently make sense to provide tutorials for the default aircraft: "At first startup, I noticed the "Need help? use help->tutorials" message, and because I had no idea how to start up the plane (it would be just plain try and fail, than try something else), I did just that and started some basic tutorials. I wouldn't say going through the tutorials was frustrating, but they were quite boring and I was eager to get in the air as soon as possible." [http://www.flightgear.org/forums/viewtopic.php?f=28&t=16795] (also see [[Release:Aircraft Selection Criteria]])
+
** "I discovered however, that there can be some problems on Linux about the planes (eg. some versions of the L39 Albatros undergoing several improvements lately). The problems can be caused by Linux being case sensitive about file paths (Windows is not), and I suspect, more models could suffer from some developers not knowing that. It's easy to fix if you know about the problem, but it would better be done on the developer side, as you never know if the smoke is just not implemented or missing due to this. Not to mention how lengthy it would be to go through more aircraft..." [http://www.flightgear.org/forums/viewtopic.php?f=28&t=16795]
+
** The installer should be updated to show a warning regarding TerraSync update time [http://flightgear.org/forums/viewtopic.php?f=68&t=18942&p=175779#p175779]
+
 
+
* '''Usability''':
+
** {{Thumbs down}} A little downside is how the FGcom is done as a standalone program just cooperating with FG itself. It took me some fiddling with the settings for about two hours to get it working, but again installation was simply done from repos (FGcom and than FGcomGui as well). [http://www.flightgear.org/forums/viewtopic.php?f=28&t=16795] (this is planned [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg38057.html])
+
** {{Thumbs down}} Most likely because of the Intel graphics, I suffered for a long time from a problem with aircraft models (and some ground textures too) being black or missing some parts (see my post in an older thread complaining about similar problem). I solved it by adding a command line option turning off texture compression. [http://www.flightgear.org/forums/viewtopic.php?f=28&t=16795] (also see [[Release:Aircraft Selection Criteria]])
+
** I also vote for hosting a non-GPL hangar on the FG site, and tighter coordination with the aircraft developers (I think they should be asked to actively propose their models to the hangar once it is created, of course there could be link to their site/hangar). It would help nice models to be more easily found, an more people could enjoy them. And that's why people spend time creating them, right? [http://www.flightgear.org/forums/viewtopic.php?f=28&t=16795]
+
** We should probably add a new menu to the menubar for our online resources (wiki, forum, issue tracker, FAQ) so that people more easily find important resources just by selecting them from a menu.
+
 
+
* '''Release Candidates''':
+
** Release Candidates should probably have a higher default logging level while writing everything to a log file that can be easily shared via the issue tracker/forums, so that end users can provide better bug reports.
+
** How about having a test run a week or two in advance, just to make sure  we can indeed produce release installers for Win+Mac - and then release  the first RC on December 17th/18th or 19th [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg38765.html]
+
** We've already got a fairly extensive lead-in time for the release.  More testers on more platforms would seem to be the answer.  Perhaps we should advertize for testers of those platforms that aren't adequately covered by developers running git? Making a complete package available, not just the binaries would help, as testers wouldn't need to be git-aware. [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg38764.html]
+
** The main area to improve is to distribute release candidates for all  platforms earlier - preferably starting immediately after the freeze. That would already give us more time for testing - without extending the  actual freeze period.[http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg38765.html]
+
** aircraft packages should be prepared prior to the official release date: "For the 2.8 release I didn't start making aircraft download packages (or uploading them to the ftp servers) until after the official release date which was a mistake" [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg39227.html]
+
** RC's should probably be built with [[Built-in Profiler]] support enabled [http://flightgear.org/forums/viewtopic.php?f=68&t=18839&p=175689#p175689].
+
** When releasing RC's do not limit them to Win/Mac binaries, but also create source snapshots so that distros can already work on the next package versions.
+
** For RC's it might make sense to distribute binaries with debugging symbols included and [[Built-in Profiler|profiling support enabled]], so that people can more easily provide useful bug reports, or even backtraces.
+
** Also, many end users still prefer using the forum for making bug reports and don't use the issue tracker - it might help to add a link (button) to the issue tracker to the about dialog or maybe even directly to the help menu ("Report an issue") (same for wiki/troubleshooting/faq ?)
+
** it might make sense to give wider exposure to our RCs, i.e. via the newsletter - possibly by adjusting the release schedule
+
 
+
* '''Build related''':
+
* A normal Linux user has practically no chance to get last stable on his box running if it isn't in his distro - a normal Windows user gets everything nice and streamlined. [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg38817.html]
+
* According to the issue tracker there were 3-5 different contributors who provided C++ patches that didn't end up reviewed/merged, which caused some irritation.
+
  
==== 2.8 ====
+
== Lessons learned ==
* {{Thumbs down}} Lack of stress-testing: A number of users reported severe memory growth issues (with fgfs consuming as much as 14gb of RAM), many directly related to new features, such as random buildings: [http://flightgear.org/forums/viewtopic.php?f=17&t=16758&p=160765&hilit=vegetation#p160747] [http://flightgear.org/forums/viewtopic.php?f=17&t=17249] [http://flightgear.org/forums/viewtopic.php?f=68&t=17114&start=15#p163829] [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg38007.html] These could have probably been identified earlier by running FG for extended periods of time, and testing the shipped aircraft with the default KSFO scenery, and new features such as random buildings enabled.
+
See [[Release plan/Lessons learned]] for a list of things that turned out well and should be kept for the next release as well as thing that didn't turn out so well and should be changed for future releases. Ideally, the release plan should be updated and augmented so that the lessons learned are incorporated accordingly.
* {{Thumbs down}} Lack of graceful feature scaling: Several users with old graphics cards reported not being able to run FG 2.8 without crashing during startup, because the FG defaults didn't scale for old hardware [http://flightgear.org/forums/viewtopic.php?f=17&t=17308]
+
<!-- {{Appendix}} -->
* {{Thumbs down}} According to noaa.gov it seems that the NOAA metar source got phased out in 04/2012 and moved to a new URL[http://weather.noaa.gov/weather/coded.html], some users reported issues related to this[http://flightgear.org/forums/viewtopic.php?f=17&t=17457&p=165784&hilit=metar#p165784]. However, the metar URL is currently hard-coded in the fgfs/metar source code - in addition, the default format is no longer a plain text dump [http://www.aviationweather.gov/adds/metars/]. It would make sense to make the URL a string property that can be put into preferences.xml and then use a Nasal listener to parse the resulting XML/HTML and set a plain text property instead, that can be processed by the existing metar code.
+
* {{Thumbs down}} [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg38113.html Broken OSX downloads]
+
* {{Thumbs down}} [http://flightgear.org/forums/viewtopic.php?f=21&p=165841#p165841 the OSX 10.8 release and code signing caused some irritation]
+
* {{Thumbs down}} [http://flightgear.org/forums/viewtopic.php?f=47&t=14883&start=330#p166062 After the 2.8 release a number of users on the forums reported seeing GLSL related errors, because some of the 2.8 shaders used GLSL features only supported by more recent GLSL compilers/drivers - it would probably make sense to test all shader settings on all 3 platforms and check if they cause any errors (and "backport" shaders as necessary). Apple/Mac OSX seems to be more problematic]
+
* {{Thumbs down}} [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg38121.html Microsoft Redistributables were apparently not shipped with the Windows installer ?]
+
* {{Thumbs down}} [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg38089.html The changelog should be written as early as possible]
+
* The code freeze could probably be lifted for patches that are not normally enabled/used by any default code paths (or shipped aircraft) in a FlightGear release. This probably involves Nasal extension functions, fgcommands, telnet commands, but also custom hard coded instruments or instrumentation-related APIs (think Canvas). Basically, whenever there's no chance to break a release by committing a certain patch, because the code path will not be executed by default without explicitly enabling it. For 2.8, this also meant that the Nasal [[Canvas]] API could not be included due to the code freeze, which however wasn't used by any systems or aircraft - so that there would have been zero chance for breakage [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg37622.html] [http://flightgear.org/forums/viewtopic.php?f=71&t=17397#p165413].
+
* The wiki contains a number of resources to help new users with hardware decisions, such as [[Hardware Recommendations]] [[Notebooks known to run FlightGear]] and [[Supported Video Cards]] - these should probably be updated for each release several weeks in advance.
+
  
==== 2.6 ====
+
== Related content ==
* {{Thumbs up}} feature freeze in general
+
=== Mailing lists ===
*: helped a lot during release management. Kept the commit traffic low and thus helped identifying those commits required to pick into the release.
+
* {{cite web
* {{Thumbs down}} feature freeze for aircraft
+
|url = http://sourceforge.net/p/flightgear/mailman/message/34701971/
*: Technically, a feature freeze for aircraft is not necessary as long as this aircraft is not part of the base distribution and no common parts are affected. If it's guaranteed that the changes remain in FGDATA/Aircraft/MyAircraft and no other files are touched, these updates should be OK up to shortly before the release.
+
|title = <nowiki>[Flightgear-devel] Release 3.8</nowiki>
* {{Thumbs down}} switching to a new version of supporting libraries like OSG.
+
|author = Torsten Dreyer
*: The move to OSG 3.x introduced some major issues. If at all possible, switch to a new library early in the development cycle.
+
|date = Dec 17th, 2015
* {{Thumbs down}} manual creation of release candidates and the release binaries
+
}}
*: It's preferable to have equal numbers for release candidates for all O/S and probably a git-tag for each candidate.
+
* {{Thumbs down}} release date/time frame
+
*: It took several days to release all the subparts. Might be better to upload all files and pages to hidden folders and publish them all at once (or at least within a couple of hours). That'll have several advantages:
+
*:* no big difference between releases for the various OS.
+
*:* the website will switch to the new release state quickly. With 2.6.0, the aircraft page was published before the setup. The release announcement was published even later.
+
  
 
[[Category:Core developer documentation]]
 
[[Category:Core developer documentation]]
 
[[Category:FlightGear]]
 
[[Category:FlightGear]]
 +
[[Category: Release]]

Latest revision as of 05:28, 15 June 2016

Current release: 2018.3 (9 Dec 2018)
Next release: 2019.1 (a few days from now)
See release plan for details.

The release plan is the process by which a new version of FlightGear is released. The release plan is actually a continual work-in-progress, and is refined with every new release.

The original release plan.

FlightGear has had two release plans over history. The original release plan was developed by Mathias Fröhlich, Martin Spott, Thorsten Brehm and Torsten Dreyer during LinuxTag 2011. The current plan was proposed by Torsten Dreyer after the 3.6 release was cancelled.

To suggest improvements and/or changes to the release plan, it is recommended to get in touch via the mailing list. Improvements can be based on the lessons learned from previous releases.

General release concept

A new version of FlightGear is released every three months, meaning four releases per year. On the 17th of the month, new release branches are created and the build server creates the binaries and uploading them to SourceForge. If any changes are made to the release branch, a new bugfix release is created. The version of the next branch is incremented. And development coninutes as normal, with new nightly builds be created after each change. The table below shows the release cycle. See also this mailing list post.

Month Number in cycle
January 4 (previous year)
February 1
March 1
April 1
May 2
June 2
July 2
August 3
September 3
October 3
November 4
December 4

Version numbers

FlightGear version numbers consist of three digits, separated by dots:

Before 2016.1

  • Major (3.4.0): Only increased after significant changes to the functionality of the software (e.g., 1.x.x → 2.0.0 (due to switch to OSG).
  • Minor (3.4.0): Has two applications:
    • Stable releases always have even numbers (e.g. 2.8.0, 2.10.0, 2.12.0).
    • The latest Git version or nightly build uses an odd number, always one more than the latest stable release's minor revision numbere. For example, when the latest release was 3.4.0, the current development stream was 3.5.0.
  • Revision (3.4.0): Increased by bugfix releases (e.g., 2.12.1).

2016.1 and after

  • Year (2016.1.0): The year the version was released.
  • Number (2016.1.0): Which release of the year the version is (note: starts at 1).
  • Revision (2016.1.0): Indicates one of two things:
    • In the latest Git version or nightly build, this digit is 0, indicating that it is unstable.
    • When a new release is created, this digit is set to 1. With bugfix that is made, this digit is increased by 1, and a new version created.
Note  In general, release are referred to by their first two digits (e.g., 3.4). However, when filing a bug report or debugging problems, it is a good idea to give the full release number.

Detailed time schedule and checklist

  1. Just after the next release, the next default airport is decided on by a poll on the forum. The next release will be named after it.
  2. (On the 17th of the release month): The first Jenkins script is triggered to create release/xxxx.x.0 branches with version xxxx.x.0.
  3. Jenkins creates the binaries for xxxx.x.1.
  4. Patches going into the release/xxxx.x.0 branch automatically trigger a new build with a increase of the revision version number (see above) and we immediately have a bugfix release.
  5. On the next branch, the version number is changed.
  6. Nightly builds are created from next after every push in that branch.

The process is repeated after three months.

Version files

FGData
fgdata/version
SimGear
simgear/version
FlightGear
flightgear/version
FGRun
fgrun/version

Bug tracking

The bugtracker is the primary source of bug reports. Unlike the forum or mailing list, bugs reported there will be tracked, making it easier for developers to keep up with them. When reporting bugs, it is best to provide as much information as possible to more easily find the bug. If you can provide a backtrace, please do so and attach it to the bug report. When creating backtraces, please use "thread apply all bt full" at the gdb command prompt.


Lessons learned

See Release plan/Lessons learned for a list of things that turned out well and should be kept for the next release as well as thing that didn't turn out so well and should be changed for future releases. Ideally, the release plan should be updated and augmented so that the lessons learned are incorporated accordingly.

Related content

Mailing lists