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

Changes

Jump to: navigation, search

Release plan

2,036 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 '''release plan''' is the process by which a new version of [[FlightGear]]This is released. The release plan was originally developed by Mathias Fröhlichis 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 Release Concept ===New FlightGear releases will be scheduled twice a year. The magic number To suggest improvements and/or changes to remember is 17 (we tried 42the release plan, 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 will be created for SimGear, FlightGear and FGDATA[[Release plan/Lessons learned|lessons learned]] from previous releases.
After branching== General release concept ==A new version of FlightGear is released every three months, we will allow one month for bug fixing in 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 will take 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 will be 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 =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.4.0 =&gt; current development stream is 2.5.0, next official release is 2.6.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 (<ttu><nowiki>{{GitStatus:frozen}}3</nowikiu></tt># '''Jan/Jul 17th.4.0):''' Create new release branch, assign new version number to dev-stream, re-open streams##Send a mail Only increased after significant changes to the flightgear-devel mail-list, asking not to commit/push anything, declare the streams "closed" or "red"##Post an update to the forum topic##Change the content functionality of wiki template at [[Template:GitStatus]] to <tt><nowiki>{{GitStatus:closed}}</nowiki></tt>##Bump up the version-number of simgear/next, flightgear/next and fgdata/master to an even number software (2e.5g.0 -> 2, 1.6x.0)##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 "version/x → 2.6.0"##:''git tag -a version/2.6.0'' (Enter a wise commentdue to switch to [[OSG]])##Create the release branches on simgear, flightgear and fgdata named release/2.6.0##:* ''git branch release/2.6.0'Minor'''##On the next/master branches, bump up the version-number of simgear, flightgear and fgdata to an odd number (23.6.0 -<u>4</u> 2.7.0): Has two applications:##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'Stable releases' (Enter a wise comment)##Push the branches next/master ''always have 'and'even numbers'' release/2(e.6g.0 '''and''' the tags upstream##:for flightgear, simgear and fgdata: ''git push origin release/2.68.0''##:for flightgear, simgear and fgdata: ''git push origin version/2.610.0''##:for flightgear, simgear and fgdata: ''git push origin version/2.712.0).** The ''##:for flightgear and simgear: 'latest [[Git]] version'git push origin next''##:for fgdata: or ''git push origin master''##: Declare dev-streams "open" or "green"##: Change the content of wiki template at [[Template:GitStatusFlightGear build server|nightly build]] to <tt><nowiki>{{GitStatus:open}}</nowiki></tt>##: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:uses an ''odd number' Start preparing ', always one more than the latest stable release notes and a press announcement# '''Feb/Aug 17th:''' Create binaries/installerss minor revision numbere. For example, pack fgdata, publish files, announce new version, close when the latest release-branch##Tag the release/2was 3.64.0 branches of simgear, flightgear and fgdata and push the tagscurrent development stream was 3.##:for flighgear, simgear and fgdata: ''git tag version/2.65.0-final''##:for flighgear, simgear and fgdata: ''git push origin version/2.6.0-final''##Merge the branch release/2.6.0 into * '''masterRevision''' (3.4.<u>'''NOT'''0</u> next) for flightgear and simgear and push the branch##:We don't have a next branch for fgdataIncreased by bugfix releases (e.g., 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.612.1).0-final##:''git push origin master''
=== To bump up the version number 2016.1 and after ===* fgdata** edit the ''version'Year' file* SimGear** edit the ''(<u>2016</u>.1.0): The year the version'' filewas released.* FlightGear** edit the ''version'Number' file** <s>edit ''CMakeLists(2016.txt''<u>1</su>.0): Which release of the year the version is (note: starts at 1).**: <s>change the line '''find_packageRevision''' (SimGear 22016.51.<u>0 REQUIRED)'''</su>): Indicates one of two things:** <s>edit In the ''src/Main/options.cxx'latest [[Git]] version'</s>**: <s>change the line ''or 'static char required_version''[[FlightGear build server|nightly build]] = "2.5.0";'''</s>** <s>edit configure.ac</s> (Obsolete, automake this digit is gone)0, indicating that it is unstable.**: <s>change the line When a new '''AC_MSG_CHECKING([for SimGear 2.5.0 or newer])release'''</s>is created, this digit is set to 1. With bugfix that is made, this digit is increased by 1, and a new version created.
=== Definition of Repository States ===* Open/Green: Normal development of the code base and fgdata. Unrestricted (well{{note|In general, sort of) access to the streams. This state lasts for five month 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 referred 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 by their first two digits (e.g. the c172p, 3.4) enter the frozen state and shall not undergo major changes in that period.* Closed/Red*:Nothing shall be pushed to the development streams (simgearHowever, flightgear and fgdata). This state when filing a bug report or debugging problems, it is for creating a good idea to give the full release branches. It lasts for just a few hours on Jan 17th and Jul 17th around 12:00 UTCnumber.}}
=== Bug fix committing policy =Detailed time schedule and checklist ==Fixes for bugs during # Just after the shakedown test of next release, the next default airport is decided on by a poll on the forum. The next release branch may will be applied to named after it.# (On the 17th of the branches next or release month): The first Jenkins script is triggered to create <code>release/2xxxx.6x.0.A fix goes into release</2code> branches with version xxxx.6x.0 if .# Jenkins creates the development of next has moved forward and this fix does not apply therebinaries for xxxx. It also goes x.1.# Patches going into the <code>release /xxxx.x.0</code> branch if there will be automatically trigger a better fix for nextnew build with a increase of the revision version number (see [[#2016.1 and after|above]]) and we immediately have a bugfix release. A fix goes into next if it is also solves an issue for # On the <code>next </code> branch, the versionnumber is changed. Cherry-pick this commit into the release# Nightly builds are created from <code>next</2.6.0 code> after every push in that 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 branchThe process is repeated after three months.
=== Bug Tracking =Version files ==The ; FGData: {{fgdata file|version}}; SimGear: {{simgear file|version}}; FlightGear: {{flightgear file|version}}; FGRun: [http://flightgear-bugssourceforge.googlecode.com bugtrackernet/p/flightgear/fgrun/ci/next/tree/version fgrun/version] will be our primary source <!--== Bug fix committing policy ==Fixes for bugs during the bug fixing period. Bugs reported on shakedown test of the mailing list or forum will not release branch may be tracked! Reporters shall be requested applied to file a bug report at the bugtrackerbranches next or release/2. Bugs shall be assigned a priority and a keyword to make the assignment to a developer easier8. 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 provided0. Bugs assigned a high priority will be downgraded, A fix goes into release/2.8.0 if no progress has been made over a certain amount the development of timenext has moved forward and this fix does not apply there. This is to prevent It also goes into the release from being blocked by branch if there will be a bug that no developer is able (or willing) to better fixfor next. The only exception A fix goes into next if it is "does not compile also solves an issue for one of the major platforms", which certainly is a releasenext version. Cherry-blockerpick this commit into the release/2.8.0 branch.
Bugs that were present in the latest stable '''DO NOT''' merge next into 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.68.0 or vice versa. Most likely, there will be commits that are not welcome in or even break the list of fixed bugs]other branch.-->
=== Legacy =Bug tracking ==The branch for version 2[http://sourceforge.2net/p/flightgear/codetickets/ bugtracker] is the primary source of bug reports.0 Unlike the forum or mailing list, bugs reported there will be left untouchedtracked, 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. No release has ever been created from this branchWhen creating backtraces, please use "thread apply all bt full" at the gdb command prompt.
The last official release was made from branch ''release/2.4.0'', tag ''version/2.4.0<!-final''.- === Tasks and owners ===
If everything goes well, version 2.6.0 will The following table should be available around Febupdated and augmented after each release, 18th 2012according to the [[Release plan#Lessons learned|Lessons learned]] section below.
{| class="wikitable"! Stage! width== Tasks and Owners ==="500px" | Task! Owner(taskowners not yet assigneds)* |-! rowspan="7" | Preparation| 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]], [https://www.gitorious.org/fg/getstart/ The Manual], wiki* | Stuart, Gijs and anyone else|-| Pack RC and final version of FGDATAfgdata* ||-! rowspan="5" | Create the RC and final version (source| Source-tarball)* Create the RC and final version for | Curt|-| Linux* Create the RC and final version | ThorstenB (for openSUSE)|-| Windows* Create the RC and final version for | Curt|-| MacOS* | Tat/James|-| Distribute files to download servers* | Curt|-! rowspan="3" | 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.6.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/magazines.| '''EVERYBODY'''|}
=== Open Itemsitems, Questions =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 =learned ==This is See [[Release plan/Lessons learned]] for a list of lessons learned from the previous release, things that turned out well and should be kept for the next release as well as thing thad that didn't turn out so well and should be changed for future releases.* Good: feature freeze in general*: helped a lot during Ideally, the release management. Kept the commit traffic low plan should be updated and thus helped identifying those commits required to pick into augmented so that the releaselessons learned are incorporated accordingly.* Not so good: feature freeze for aircraft<!-- {{Appendix}} --> == Related content ===== Mailing lists ===*{{cite web|url = http: 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.* Not so good: switching to a new version of supporting libraries like OSG|title = <nowiki>[Flightgear-devel] Release 3.8</nowiki>*: The move to OSG 3.x introduced some major issues. If at all possible|author = Torsten Dreyer|date = Dec 17th, switch to a new library early in the development cycle.2015* Not so good}} [[Category: manual creation of release candidates and the release binariesCore developer documentation]]*[[Category: It's preferable to have equal numbers for release candidates for all O/S and probably a git-tag for each candidate.FlightGear]][[Category: Release]]

Navigation menu