Difference between revisions of "Release plan"

From FlightGear wiki
Jump to: navigation, search
m (Detailed time schedule and checklist: Fix typo in syntax)
m (Definition of repository states)
Line 97: Line 97:
! [[File:Traffic light green.png|20px]]
! [[File:Traffic light green.png|20px]]
! Open/Green
! 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.
| 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]]
! [[File:Traffic light yellow.png|20px]]

Revision as of 03:19, 17 July 2014

Current release: 2020.1 (11 May 2020)
Next release: 2020.2 (111 days from now)
See release plan for details.

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 original plan

This release plan was originally developed by Mathias Fröhlich, Martin Spott, Thorsten Brehm and Torsten Dreyer during LinuxTag 2011.

If you think you have something to contribute to the release process, feel free to edit this page. In particular, improvements should be based on Release plan/Lessons learned from past releases. Please discuss this concept at the mailing-list.

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.

Cquote1.png 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[1]
— 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.

The development stream of SimGear, FlightGear, FGRun 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, seperated by dots:

  • Major (2.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 (2.4.1): has two applications:
    • Stable releases always have even numbers, i.e. 2.6.0, 2.8.0, 3.0.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 was 2.8.0, the current development stream is 2.9.0.
  • Revision (2.4.1): is increased by bugfix releases, i.e. 2.8.1, 2.8.2, 2.8.3.

When referring to a major release in general, only the first two digits should be used, i.e. 2.6 refers to 2.6.0, 2.6.1 etc.

Detailed time schedule and checklist

  1. Dec/Jun 17th: Development stream is declared "frozen" or "yellow"
    1. Send a mail to the flightgear-devel mailing-list to announce the state, add a call for screenshots
    2. Create a "release preperations" topic at the forum and make it a "Global Announcement", add a call for screenshots
    3. Change the content of wiki template at Template:GitStatus to {{GitStatus:frozen}}
    4. 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)
    5. Compile and test drive FlightGear with the new version-number
    6. Commit the new version number to next (flightgear+simgear+fgrun) and master(fgdata)
    7. Tag (annotated) flightgear, simgear, fgrun and fgdata with version/3.0.0
      git tag -a version/3.0.0 (Enter a wise comment)
    8. Push the branches next/master and the tags upstream
      for flightgear, fgrun and simgear: git push origin next
      for fgdata: git push origin master
      for the tags (all repos): git push origin version/3.0.0
  2. Jan/Jul 17th: Create new release branch, assign new version number to dev-stream, re-open streams
    1. Pull current Git, create the release branches (for sg/fg/fgrun/fgdata):
      git pull
      git branch release/3.0.0
    2. 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)
    3. Compile and test drive FlightGear with the new development version number
    4. Commit the changes of version-number to next/master
    5. Tag (annotated) flightgear, simgear, fgrun and fgdata with "version/2.9.0"
      git tag -a version/2.9.0 (Enter a wise comment)
    6. Push the branches next/master and release/3.0.0 and the tags upstream
      for flightgear, simgear, fgrun and fgdata: git push origin release/3.0.0
      for flightgear, fgrun and simgear: git push origin next
      for fgdata: git push origin master
      for the tags (all repos): git push origin version/3.1.0
    7. Declare dev-streams "open" or "green"
      Ask a wiki admin to change the content of wiki template at Template:GitStatus to {{GitStatus:open}}
      Send a mail to the flightgear-devel mailing-list to announce the state.
    8. Trigger James for the Jenkins-builds and Curt for a snapshot release and ThorstenB for the OpenSuse build
  3. Feb/Aug 1st: Start preparing the release notes and a press announcement
  4. Feb/Aug 17th: Create binaries/installers, pack fgdata, publish files, announce new version, close the release-branch.
    1. 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.
    2. Tag the release/3.0.0 branches of simgear, flightgear, fgrun and fgdata and push the tags.
      for flighgear, simgear, fgrun and fgdata: git tag version/3.0.0-final
      for flighgear, simgear, fgrun and fgdata: git push origin version/3.0.0-final
    3. Merge the branch release/3.0.0 into master (NOT 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:
      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
    4. 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

Definition of repository states

State Description
Traffic light green.png 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.
Traffic light yellow.png 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.

Traffic light red.png 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

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 next if it is also solves an issue for the next version. Cherry-pick this commit into the release/2.8.0 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

The 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 the list of fixed bugs.

Tasks and owners

The following table should be updated and augmented after each release, according to the Lessons learned section below.

Task Owner(s) Status for 2.12
Announce the state-change of the dev-streams, cross-post to JSBSim list (see lessons learned!) TorstenD
Create/maintain the git branches TorstenD
Track the bugs on the tracker, trigger developers, adjust bug-priorities ThorstenB, Gijs, James, ...
Sync the language files so they can be translated ThorstenB, James
Beta testing EVERYBODY
Update documentation: FAQ, The Manual, wiki Stuart, Gijs and anyone else
Pack RC and final version of FGDATA
Create the RC and final version Source-tarball Curt
Linux ThorstenB (for openSUSE)
Windows Curt
MacOS Tat/James
Distribute files to download servers Curt
Make adjustments on the web-site Collect/make screenshots for the gallery Curt
Generate aircraft page Curt, Gijs
Tag the newsletter template according to the released version

[[Category:Changes after 2.12]]

Hooray, Gijs, Stuart (other wiki admins)
Announce the new version to the public Write a changelog: Next Changelog 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. EVERYBODY

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."[2]
  • Automate the creation of Windows and Mac installers Done Done [3] (see FlightGear Build Server)
  • 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 [4][5][6]

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.