Release plan: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
(Present tense)
m (the release plan is no longer being used according to the devel list and .... the actual release schedule)
 
(249 intermediate revisions by 18 users not shown)
Line 1: Line 1:
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.  
{{GitStatus}}
{{Out of date}}
<!--
{{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 and how much available resource and interest there is.


[[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 multiple release plans over [[FlightGear History|history]].
* Originally, releases were sporadic, irregular and took many months of manual preparation.
* Subsequently a release plan was developed by Mathias Fröhlich, Martin Spott, Thorsten Brehm and Torsten Dreyer during [[LinuxTag]] 2011.
* A more regular plan was proposed by Torsten Dreyer after the 3.6 release was [[FlightGear Newsletter November 2015#FlightGear v3.6 canceled|cancelled]].
* Currently "Long Term Support" (LTS) releases are generated every ~24 months, with intermittent "preview" releases between them which receive less testing and support.


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>. 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. However, do not underestimate the amount of effort go create a new release!  Most of the burden falls on a few people.


=== 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.  
At any given time there are two release "stream":
* A Long Term Support (LTS) release stream. This is a stable release to which bug fixes are applied, and will be active for up to two years. Most users and aircraft developers use this release.  Currently 2020.3.
* A "preview" release, based on the development branch "next".  This is for those interested in the latest developments.  There is not currently a preview release.


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.
== Version numbers ==
FlightGear version numbers consist of three digits, separated by dots:


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 are requested not to add any new features, subsystems or alike. 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.
* '''Year''' (<u>2020</u>.1.0): The year the version was released.
* '''Number''' (2020.<u>1</u>.0): Which release of the year the version is.  
* '''Revision''' (2020.1.<u>0</u>): The patch revision on that release.


=== Version numbers ===
{{note|In general, release are referred to by their first two digits (e.g., 2020.3). However, when filing a bug report or debugging problems, it is a good idea to give the full release number.}}
* '''Major releases''' always have '''even numbers''' as the second version element, i.e. 2.4.0, 2.6.0, 2.8.0.
* '''Bugfix releases''' increase the least significant digit: 2.6.1, 2.6.2, 2.6.3.
* The '''development stream''' (''latest Git version'') uses an '''odd number''', increasing the second element of the latest stable release's version by 1: (latest release is 2.6.0 =&gt; current development stream is 2.7.0, next official release is 2.8.0).
* The major version number is increased after significant changes to the functionality of the software (i.e. FG 1.x => 2.0 due to switch to OSG).


=== Detailed time schedule and checklist ===
== Detailed time schedule and checklist ==
# '''Dec/Jun 17th:''' Development stream is declared "frozen" or "yellow"
# Just after an LTS is generated, the next default airport is decided on by a poll on the forum. The next LTS release will be named after it.
#:Send a mail to the flightgear-devel mailing-list to announce the state
# A series of "preview" releases generated for cutting edge users. For each release:
#:Create a "release preperations" topic at the forum and make it a "Global Announcement"
## A release branch is cut from "next". E.g. release/2021.1
#:Change the content of wiki template at [[Template:GitStatus]] to <code><nowiki>{{GitStatus:frozen}}</nowiki></code>
## The version files are incremented. 
# '''Jan/Jul 17th:''' Create new release branch, assign new version number to dev-stream, re-open streams
## Builds are generated.
##Send a mail to the flightgear-devel mail-list, asking not to commit/push anything, declare the streams "closed" or "red"
# When a new LTS preview is declared (after ~12 months):
##Post an update to the forum topic
## A release branch is cut from "next". E.g. release/2022.1
##Change the content of wiki template at [[Template:GitStatus]] to <code><nowiki>{{GitStatus:closed}}</nowiki></code>
## The version files are incremented.
##Bump up the version-number of simgear/next, flightgear/next and fgdata/master to an even number (2.5.0 -> 2.6.0)
## Builds are generated for the preview LTS. Testing of aircraft against these releases is strongly encouraged.
##Compile and test drive FlightGear with the new version-number
## Additional branches are created for subsequent releases from the original release branch (e.g. release/2022.1 -> release/2022.2)
##Commit the new version number to next (flightgear+simgear) and master(fgdata)
## Fixes are merged into the release branch as well as "next"
##Tag (annotated) flightgear, simgear and fgdata with <tt>version/2.6.0</tt>
## Further builds and release are generated until an LTS is declared (e.g release/2022.3).
##:''git tag -a version/2.6.0'' (Enter a wise comment)
## fgaddon is branched and a new catalog generated.
##Create the release branches on simgear, flightgear and fgdata named <tt>release/2.6.0</tt>
##:''git branch release/2.6.0''
##On the next/master branches, bump up the version-number of simgear, flightgear and fgdata to an odd number (2.6.0 -> 2.7.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.7.0"
##:''git tag -a version/2.7.0'' (Enter a wise comment)
##Push the branches next/master '''and''' release/2.6.0 '''and''' the tags upstream
##:for flightgear, simgear and fgdata: ''git push origin release/2.6.0''
##:for flightgear, simgear and fgdata: ''git push origin version/2.6.0''
##:for flightgear, simgear and fgdata: ''git push origin version/2.7.0''
##:for flightgear and simgear: ''git push origin next''
##:for fgdata: ''git push origin master''
##: Declare dev-streams "open" or "green"
##: 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/2.6.0 branches of simgear, flightgear and fgdata and push the tags.
##:for flighgear, simgear and fgdata: ''git tag version/2.6.0-final''
##:for flighgear, simgear and fgdata: ''git push origin version/2.6.0-final''
##Merge the branch release/2.6.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/2.6.0-final
##:''git push origin master''


=== To bump up the version number ===
* fgdata
** edit the ''version'' file
* SimGear
** edit the ''version'' file
* FlightGear
** edit the ''version'' file
** <s>edit ''CMakeLists.txt''</s>
**: <s>change the line '''find_package(SimGear 2.5.0 REQUIRED)'''</s>
** <s>edit ''src/Main/options.cxx''</s>
**: <s>change the line '''static char required_version[] = "2.5.0";'''</s>
** <s>edit configure.ac</s> (Obsolete, automake is gone)
**: <s>change the line '''AC_MSG_CHECKING([for SimGear 2.5.0 or newer])'''</s>


=== Definition of repository states ===
== Version files ==
* Open/Green
; FGData: {{fgdata file|version}}
: 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.
; SimGear: {{simgear file|simgear-version}}
* Frozen/Yellow
; FlightGear: {{flightgear file|flightgear-version}}
*: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.
== Bug fix committing policy ==
* Closed/Red
Fixes for bugs during the preview release are applied to both "next" and the release branch (e.g. release/2022.2)
*: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 ===
'''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.
Fixes for bugs during the shakedown test of the release branch may be applied to the branches next or release/2.6.0.
-->
A fix goes into release/2.6.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 next if it is also solves an issue for the next version. Cherry-pick this commit into the release/2.6.0 branch.


'''DO NOT''' merge next into release/2.6.0 or vice versa. Most likely, there will be commits that are not welcome in or even break the other branch.
== 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 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.


=== 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.
=== Tasks and owners ===
 
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.6.0 the list of fixed bugs].
 
=== Legacy ===
The branch for version 2.2.0 will be left untouched. No release has ever been created from this branch.
 
The last official release was made from branch ''release/2.4.0'', tag ''version/2.4.0-final''.


If everything goes well, version 2.6.0 will be available around Feb, 18th 2012.
The following table should be updated and augmented after each release, according to the [[Release plan#Lessons learned|Lessons learned]] section below.


=== Tasks and owners ===
{| class="wikitable"
{|class="wikitable"
! Stage
!
! width="500px" | Task
! width="500px" | Task
! Owner(s)
! Owner(s)
|-
|-
! rowspan="6" |  
! 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
|-
|-
Line 120: Line 78:
| Track the bugs on the tracker, trigger developers, adjust bug-priorities
| Track the bugs on the tracker, trigger developers, adjust bug-priorities
| ThorstenB, Gijs, James, ...
| ThorstenB, Gijs, James, ...
|-
| Sync the language files so they can be translated
| ThorstenB, James
|-
|-
| Beta testing  
| Beta testing  
Line 127: Line 88:
| 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 141: Line 102:
|-
|-
| MacOS
| MacOS
| Tat
| Tat/James
|-
|-
| Distribute files to download servers
| Distribute files to download servers
| Curt
| Curt
|-
|-
! 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
|-
| Generate aircraft page
| 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 2.6.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 the creation of Windows and Mac installers
* 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 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>
{{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 ==
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.
<!-- {{Appendix}} -->
 
== Wiki articles that should be updated ==
 
See [[:Category:Articles to be updated for each release]]


=== Lessons learned ===
== Related content ==
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 thad didn't turn out so well and should be changed for future releases.
=== Mailing lists ===
* {{Thumbs up}} feature freeze in general
* {{cite web
*: helped a lot during release management. Kept the commit traffic low and thus helped identifying those commits required to pick into the release.
|url = http://sourceforge.net/p/flightgear/mailman/message/34701971/
* {{Thumbs down}} feature freeze for aircraft
|title = <nowiki>[Flightgear-devel] Release 3.8</nowiki>
*: 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.
|author = Torsten Dreyer
* {{Thumbs down}} switching to a new version of supporting libraries like OSG.
|date = Dec 17th, 2015
*: The move to OSG 3.x introduced some major issues. If at all possible, switch to a new library early in the development cycle.
}}
* {{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 plans]]

Latest revision as of 18:29, 8 December 2022

Current release: 2020.3.19 (18 Oct 2023)
Next release: 2020.3.20
See release plan for details.
This article or section contains out-of-date information

Please help improve this article by updating it. There may be additional information on the talk page.

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 and how much available resource and interest there is.

The original release plan.

FlightGear has had multiple release plans over history.

  • Originally, releases were sporadic, irregular and took many months of manual preparation.
  • Subsequently a release plan was developed by Mathias Fröhlich, Martin Spott, Thorsten Brehm and Torsten Dreyer during LinuxTag 2011.
  • A more regular plan was proposed by Torsten Dreyer after the 3.6 release was cancelled.
  • Currently "Long Term Support" (LTS) releases are generated every ~24 months, with intermittent "preview" releases between them which receive less testing and support.

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. However, do not underestimate the amount of effort go create a new release! Most of the burden falls on a few people.

General release concept

At any given time there are two release "stream":

  • A Long Term Support (LTS) release stream. This is a stable release to which bug fixes are applied, and will be active for up to two years. Most users and aircraft developers use this release. Currently 2020.3.
  • A "preview" release, based on the development branch "next". This is for those interested in the latest developments. There is not currently a preview release.

Version numbers

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

  • Year (2020.1.0): The year the version was released.
  • Number (2020.1.0): Which release of the year the version is.
  • Revision (2020.1.0): The patch revision on that release.
Note  In general, release are referred to by their first two digits (e.g., 2020.3). 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 an LTS is generated, the next default airport is decided on by a poll on the forum. The next LTS release will be named after it.
  2. A series of "preview" releases generated for cutting edge users. For each release:
    1. A release branch is cut from "next". E.g. release/2021.1
    2. The version files are incremented.
    3. Builds are generated.
  3. When a new LTS preview is declared (after ~12 months):
    1. A release branch is cut from "next". E.g. release/2022.1
    2. The version files are incremented.
    3. Builds are generated for the preview LTS. Testing of aircraft against these releases is strongly encouraged.
    4. Additional branches are created for subsequent releases from the original release branch (e.g. release/2022.1 -> release/2022.2)
    5. Fixes are merged into the release branch as well as "next"
    6. Further builds and release are generated until an LTS is declared (e.g release/2022.3).
    7. fgaddon is branched and a new catalog generated.


Version files

FGData
fgdata/version
SimGear
simgear/simgear-version
FlightGear
flightgear/flightgear-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.

Wiki articles that should be updated

See Category:Articles to be updated for each release

Related content

Mailing lists