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
(Related content)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{GitStatus}}
 
{{GitStatus}}
 +
{{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.
 
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.
Line 9: Line 10:
  
 
== General release concept ==
 
== General release concept ==
{{FGCquote
+
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].
|1= Hi Everybody,
+
  
Today, December 17th would be the day to announce the feature freeze for
+
{| class="wikitable"
3.8 if we were following the usual release schedule.
+
! Month !! Number in cycle
 
+
|-
A while ago I proposed a change in that schedule and I have spent some time
+
| January
on preparing the scripts for an automated release process since then. I
+
| style="background-color: #e55757" | 4 ''(previous year)''
think I have pretty much everything ready to go for automated releases and
+
|-
now I'd like to give it a first try for the 3.8 release next year.
+
| February
 
+
| style="background-color: #e4ae3a" | 1
For the first execution, I'd like to trigger the scripts manually on my
+
|-
local machine instead of Jenkins to have some better control of it. If it
+
| March
works out as expected, I'll put this onto our Jenkins server afterwards to
+
| style="background-color: #e4ae3a" | 1
be executed automatically for the release following after 3.8.
+
|-
 
+
| April
For now, I propose the following and would do so if nobody objects:
+
| style="background-color: #e4ae3a" | 1
* There is no feature freeze for the next (3.8) and the following releases
+
|-
* On Jan., 17th I trigger my first script to create release/3.8 branches with version 3.8.1 (!)
+
| May
* Immediately after that I let Jenkins create the binaries for 3.8.1 and we have our first release
+
| style="background-color: #6a6bd7" | 2
* Patches going into the release/3.8 branch automatically trigger a new build with a previous increase of the micro version number (3.8.2, 3.8.3,..) and we immediately have a bugfix release
+
|-
* On 'next', version numbers go to 3.9.0
+
| June
* Nightly builds are created from next after every push in that branch
+
| style="background-color: #6a6bd7" | 2
 
+
|-
After a to-be-defined period (my proposal: 3 month) we start over:
+
| July
* Create a release/3.9 branch with version 3.9.1
+
| style="background-color: #6a6bd7" | 2
* etc. etc.
+
|-
 
+
| August
Note: there will be no odd-even version number scheme (odd equals unstable,
+
| style="background-color: #63e557" | 3
even equals stable). Instead, x.x.0 is unstable, nightly from next and
+
|-
x.x.n where n >= 1 is a stable release.
+
| September
 
+
| style="background-color: #63e557" | 3
If everything works as expected, we have a major release every
+
|-
to-be-defined months, a bugfix release after every push to the release
+
| October
branch and a nightly build after every push to 'next'.
+
| style="background-color: #63e557" | 3
 
+
|-
I hope this sounds reasonable and keeps everybody happy.
+
| November
 
+
| style="background-color: #e55757" | 4
Feedback welcome.
+
|-
 
+
| December
Torsten
+
| style="background-color: #e55757" | 4
|2= {{cite web
+
|}
  | url    = http://sourceforge.net/p/flightgear/mailman/message/34701971/
+
  | title  = <nowiki>[Flightgear-devel] Relesae 3.8</nowiki>
+
  | author = <nowiki>Torsten Dreyer</nowiki>
+
  | date  = Dec 17th, 2015
+
  }}
+
}}
+
<!--
+
== General release concept (old release plan) ==
+
New FlightGear releases are scheduled twice a year. The magic number to remember is 17. On the 17th of January (the first month) and July (the seventh month), a new release branch is created for [[SimGear]], the FlightGear source, 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 committer to decide if that is the case or not. Every new feature that didn't make it into the repository by the deadline may probably easily wait for another four weeks to get committed. Remember: most aircraft are not affected by the feature freeze and aircraft developers quickly adopt and use new features as they become available
+
| {{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  = 16th Nov 2012
+
  }}
+
}}
+
 
+
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 the 18th of February and the 18th of August. Allowing a few days for distribution of the files, new versions should be publicly available around the 20th of February and August.
+
 
+
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 ==
 
== Version numbers ==
Line 96: Line 72:
  
 
== Detailed time schedule and checklist ==
 
== Detailed time schedule and checklist ==
 +
# 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.
 
# (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.
 
# Jenkins creates the binaries for xxxx.x.1.
 
# Jenkins creates the binaries for xxxx.x.1.
Line 102: Line 79:
 
# Nightly builds are created from <code>next</code> after every push in that branch.
 
# Nightly builds are created from <code>next</code> after every push in that branch.
  
The process is repeated after a set number of months (to-be-decided).
+
The process is repeated after three months.
<!--
+
# '''Dec/Jun 17th:''' Development stream is declared "frozen" or "yellow"
+
##Send a mail to the flightgear-devel mailing-list to announce the state, add a call for screenshots
+
##Create a "release preperations" topic at the forum and make it a "Global Announcement", add a call for screenshots
+
##Ask for translator for a review of the translations of the menu, help and startup entries in case there have been some mods on those files
+
##Change the content of wiki template at [[Template:GitStatus]] to <code><nowiki>{{GitStatus:frozen}}</nowiki></code>
+
##Bump up the version-number of simgear/next, flightgear/next, fgrun/next and fgdata/master to an even number (2.9.0 -> 3.0.0)
+
##Compile and test drive FlightGear with the new version-number
+
##Commit the new version number to next (flightgear+simgear+fgrun) and master(fgdata)
+
##Tag (annotated) flightgear, simgear, fgrun 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
+
##:for flightgear, fgrun and simgear: <code>git push origin next</code>
+
##:for fgdata: <code>git push origin master</code>
+
##: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
+
  
 
-- 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/fgrun/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, fgrun 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, fgrun 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
 
##:for flightgear, simgear, fgrun and fgdata: <code>git push origin release/3.0.0</code>
 
##:for flightgear, fgrun and simgear: <code>git push origin next</code>
 
##:for fgdata: <code>git push origin master</code>
 
##:for the tags (all repos): <code>git push origin version/3.1.0</code>
 
##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 or Clément for the Jenkins-builds and Curt for a snapshot release and ThorstenB for the OpenSuse build
 
##:in fgmeta:
 
##:<code>git checkout release/3.0.0</code>
 
##:<code>git submodule foreach git checkout release/3.0.0</code>
 
##:<code>git submodule foreach git pull -r</code>
 
##:<code>git add .</code>
 
##:<code>git commit -m "Bump revision"</code>
 
##:<code>git push origin release/3.0.0</code>
 
# '''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.0.0 branches of simgear, flightgear, fgrun and fgdata and push the tags.
 
##:for flighgear, simgear, fgrun and fgdata: <code>git tag version/3.0.0-final</code>
 
##:for flighgear, simgear, fgrun 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
 
##:We don't have a next branch for fgdata, no merging of the release branch here.
 
##:for flighgear, fgrun 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.
 
-->
 
 
== Version files ==
 
== Version files ==
 
; FGData: {{fgdata file|version}}
 
; FGData: {{fgdata file|version}}
Line 171: Line 86:
 
; FlightGear: {{flightgear file|version}}
 
; FlightGear: {{flightgear file|version}}
 
; FGRun: [http://sourceforge.net/p/flightgear/fgrun/ci/next/tree/version fgrun/version]
 
; FGRun: [http://sourceforge.net/p/flightgear/fgrun/ci/next/tree/version fgrun/version]
<!--  
+
<!--
== Definition of repository states ==
+
{| class="wikitable"
+
!
+
! State
+
! Description
+
|-
+
! [[File:Traffic light green.png|20px]]
+
! Open/Green
+
| Normal development of the code base and fgdata. Unrestricted (well, sort of) access to the streams. This state lasts for five months 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.
+
|-
+
! [[File:Traffic light red.png|20px]]
+
! Closed/Red
+
| Nothing shall be pushed to the development streams (simgear, flightgear, fgrun 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 ==
 
== 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.
Line 199: 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://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. When reporting bugs, it is best to provide as muh information as possible to more easily find the bug.
+
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.
  
 
<!--  
 
<!--  
Line 281: Line 174:
  
 
-->
 
-->
 +
 
== Lessons learned ==
 
== 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.
 
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.

Latest revision as of 06: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