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


Jump to: navigation, search

Release plan

2,722 bytes removed, 10:28, 15 June 2016
no edit summary
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}}{{Release}}
[[File:ReleasePlan.jpg|thumb|250px|The original plan]]This '''release plan''' was originally developed is the process by Mathias Fröhlichwhich a new version of [[FlightGear]] is released. The release plan is actually a continual work-in-progress, Martin Spott, Thorsten Brehm and Torsten Dreyer during LinuxTag 2011is refined with every new release.
If you think you have something to contribute to the release process, feel free to <span class=plainlinks>[{{SERVER}}{{localurl[File:{{NAMESPACE}}:{{PAGENAME}}ReleasePlan.jpg|action=edit}} edit this pagethumb|250px|The original release plan.]]FlightGear has had two release plans over [[FlightGear History|history]]</span>. Please discuss this concept at 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 mailing-list3.6 release was [[FlightGear Newsletter November 2015#FlightGear v3.6 canceled|cancelled]].
=== General To suggest improvements and/or changes to the release concept ===New FlightGear releases are scheduled twice a year. The magic number to remember is 17 (we tried 42plan, but that didn't turn out so well. 17 it is perfect: 1 is not a prime, 7 is a prime and so is 17)recommended to get in touch via the [[mailing list]]. On Improvements can be based on the 17th of January (1) and July (7) a new release branch is created for [[SimGearRelease plan/Lessons learned|lessons learned]], FlightGear and FGDATAfrom previous releases.
After branching, there == General release concept ==A new version of FlightGear is one month for bug fixing in released every three months, meaning four releases per year. On the release branch17th of the month, so building new release branches are created and packing of the [[build server]] creates the binaries and FGDATA takes place around February, 18th and August, 18thuploading them to SourceForge. Allowing If any changes are made to the release branch, a few days for distribution new bugfix release is created. The version of the files<code>next</code> branch is incremented. And development coninutes as normal, with new versions should nightly builds be publically available around created after each change. The table below shows the 20th of February and Augustrelease cycle. See also [http://sourceforge.net/p/flightgear/mailman/message/34701971/ this mailing list post].
The development stream of SimGear, FlightGear and FGDATA is set into a frozen state one month before the branch{| class="wikitable"! Month !! Number in cycle|-| January| style="background-day color: #e55757" | 4 ''(17thprevious year), 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 | February| style="background-color: #e4ae3a" | 1 month thinking.|-| 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|}
=== Version numbers ===* '''Major releases''' always have '''even FlightGear version numbers''' as the second version elementconsist of three digits, 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 separated by 1dots: (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 Before 2016.1 ===# * '''Dec/Jun 17th:Major''' Development stream is declared "frozen" or "yellow"##Send a mail to the flightgear-devel mailing-list to announce the state##Create a "release preperations" topic at the forum and make it a "Global Announcement"##Change the content of wiki template at [[Template:GitStatus]] to (<codeu><nowiki>{{GitStatus:frozen}}3</nowikiu></code>##Bump up the version-number of simgear/next, flightgear/next and fgdata/master to an even number (2.7.0 -> 2.84.0)##Compile and test drive FlightGear with : Only increased after significant changes to the new version-number##Commit functionality of the new version number to next software (flightgear+simgear) and master(fgdata)##Tag (annotated) flightgeare.g., simgear and fgdata with <tt>version/21.8x.0</tt>##:''git tag -a version/x → 2.80.0'' (Enter a wise commentdue to switch to [[OSG]]).##Push the branches next/master * '''andMinor''' the tags upstream##(3.<u>4</u>.0):for flightgear and simgearHas two applications: ''git push origin next''##:for fgdata: ** ''git push origin master'Stable releases'##:for the tags (all repos): ''git push origin version/2.8.0always have ''# even numbers'''Jan/Jul 17th:''' Create new release branch, assign new version number to dev-stream, re-open streams<!-- We don't really need this step(e.g..##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/2.8.0##On the next/master branches, bump up the version-number of simgear, flightgear and fgdata to an odd number (2.810.0 -> , 2.912.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"##:** The ''git tag -a 'latest [[Git]] version/2.9.0'' (Enter a wise comment)##Push the branches next/master 'or ''and'[[FlightGear build server|nightly build]]'' release/2.8.0 'uses an ''andodd number'', always one more than the latest stable release' s minor revision numbere. For example, when the tags upstream##:for flightgear, simgear and fgdata: ''git push origin latest release/2was 3.84.0'', the current development stream was 3.5.0.##:for flightgear and simgear: * ''git push origin next'Revision'##:for fgdata: ''git push origin master''##:for the tags (all repos): ''git push origin version/23.94.0''##Declare dev-streams "open" or "green"##: Ask a wiki admin to change the content of wiki template at [[Template:GitStatus]] to <codeu><nowiki>{{GitStatus:open}}0</nowikiu></code>##):Send a mail to the flightgear-devel mailing-list to announce the stateIncreased by bugfix releases (e.g., 2.12.1).## 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 === 2016.1 and a press announcementafter ===# * '''Feb/Aug 17th:Year''' Create binaries(<u>2016</installers, pack fgdata, publish files, announce new version, close the release-branchu>.## Generate latest '''getstart1.pdf''', push 0): The year the PDF to fgdata/master - and cherry-pick to the '''release branch'''version was released. Generate latest * '''getstartNumber''' HTML, push PDF and HTML to the MapServer site(2016.##Tag the release<u>1</2.8u>.0 branches ): Which release of simgear, flightgear and fgdata and push the tags.##:for flighgear, simgear and fgdata: ''git tag year the version/2.8.0-final''##is (note:for flighgear, simgear and fgdata: ''git push origin version/2starts at 1).8.0-final''##Merge the branch release/2.8.0 into * '''masterRevision''' (2016.1.<u>'''NOT'''0</u> next) for flightgear and simgear and push the branch##:We don't have a next branch for fgdata, no merging Indicates one of the release branch here.##:for flighgear and simgeartwo things: ##:** In the ''git checkout -b master origin/master'latest [[Git]] version''' or ''git checkout master'[[FlightGear build server|nightly build]]' if you already have the local branch##:''git merge version/2.8., this digit is 0-final, indicating that it is unstable.##:** When a new ''git push origin master'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.}}
=== To bump up the version number =Detailed time schedule and checklist ==* fgdata# 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.** edit # (On the ''17th of the release month): The first Jenkins script is triggered to create <code>release/xxxx.x.0</code> branches with version'' filexxxx.x.0.* SimGear# Jenkins creates the binaries for xxxx.x.1.** edit # Patches going into the ''<code>release/xxxx.x.0</code> branch automatically trigger a new build with a increase of the revision version'' file* FlightGearnumber (see [[#2016.1 and after|above]]) and we immediately have a bugfix release.** edit # On the <code>next</code> branch, the ''version'' filenumber is changed.# Nightly builds are created from <code>next</code> after every push in that branch.
=== Definition of repository states ===* Open/Green*:Normal development of the code base and fgdata. Unrestricted (well, sort of) access to the streams. This state lasts for five month The process is repeated after the release branches were created.* 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.* 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 UTCthree months.
== 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.
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.
'''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 [http://sourceforge.net/p/flightgear-bugs.googlecode.com /codetickets/ bugtracker] will be our is the primary source for the of bug fixing periodreports. Bugs reported on Unlike the forum or mailing list or forum , bugs reported there will not be tracked! Reporters shall be requested , making it easier for developers to file a bug report at the bugtrackerkeep up with them. Bugs shall be assigned a priority and a keyword When reporting bugs, it is best to make the assignment provide as much information as possible to a developer easier. Bug reports that can't be confirmed or need more input from easily find the reporter to get fixed will be assigned a new state "stalled" and only processed after more information has been providedbug. Bugs assigned If you can provide a high priority will be downgradedbacktrace, if no progress has been made over a certain amount of time. This is please do so and attach it to prevent the release from being blocked by a bug that no developer is able (or willing) to fixreport. The only exception is "does not compile for one of the major platforms"When creating backtraces, which certainly is a release-blocker. Bugs that were present in the latest stable release, and now considered please use "fixedthread apply all bt full", should be assigned a milestone label, corresponding with at 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]gdb command prompt.
=== 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. {|class="wikitable"!Stage
! width="500px" | Task
! Owner(s)
! rowspan="67" | Preparation| Announce the state-change of the dev-streams, '''cross-post to JSBSim list''' (see lessons learned!)
| 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
| Stuart, Gijs and anyone else
| Pack RC and final version of FGDATAfgdata
| MacOS
| Tat/James
| Distribute files to download servers
| Curt
! rowspan="23" | Make adjustments on the web-site
| Collect/make screenshots for the gallery
| 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
| Write a changelog: [[Changelog 2.8.0Next 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/magazinsmagazines.
=== Open items, questions ===* Automate and/or document the creation of Windows and Mac installersRC'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 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}} -->
==Related content === Lessons learned == Mailing lists ===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.* {{Thumbs up}} feature freeze in generalcite web*|url = http: helped a lot during release management. Kept the commit traffic low and thus helped identifying those commits required to pick into the release.* {{Thumbs down}} feature freeze for aircraft*: 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//sourceforge. If it's guaranteed that the changes remain in FGDATAnet/Aircraftp/flightgear/mailman/message/34701971/MyAircraft and no other files are touched, these updates should be OK up to shortly before the release.* {{Thumbs down}} switching to a new version of supporting libraries like OSG.*: The move to OSG |title = <nowiki>[Flightgear-devel] Release 3.x introduced some major issues. If at all possible, switch to a new library early in the development cycle.8</nowiki>* {{Thumbs down}} manual creation of release candidates and the release binaries|author = Torsten Dreyer*: It's preferable to have equal numbers for release candidates for all O/S and probably a git-tag for each candidate.|date = Dec 17th, 2015* {{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: Release]]

Navigation menu