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

715 bytes added, 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 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 ==Releases will have even FlightGear version numbers (2.2.0, 2.4.0, 2.6.0), bugfix releases will increase their least significant digit (2.2.0, 2.2.1, 2.2.2, 2.2.3).The Development stream uses odd version numbers and is usually on number higher than the current release (Released is 2.4.0, development stream is 2.5.0consist of three digits, next release will be 2.6.0).separated by dots:
The === Before 2016.1 ===* '''Major version number will be ''' (<u>3</u>.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.<u>4</u>.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 '''[[FlightGear build server|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.<u>0</u>): Increased by bugfix releases (e.g., 2.12.1).
=== Detailed Time Schedule 2016.1 and Checklist after ===# Dec/Jun 17th: Development stream is declared "frozen" or "yellow".#: Send a mail to the flightgear-devel mailing-list to announce the state.# Jan/Jul 17th: Create new release branch, assign new version number to dev-stream, re-open streams##Send a mail to the flightgear-devel mail-list, asking not to commit/push anything, declare the streams "closed" or "red"##Bump up the version-number of simgear/next, flightgear/next and fgdata/master to an even number * '''Year''' (2.3.0 -<u>2016</u> 2.41.0)##Compile and test drive FlightGear with : The year the new version-number##Commit the new version number to next (flightgear+simgear) and master(fgdata)##Tag (annotated) flightgear, simgear and fgdata with "version/2was released.4.0"##:* ''git tag -a version/2.4.0'Number' (Enter a wise comment)##Create the release branches on simgear, flightgear and fgdata named release/2.4.0##:''git branch release/2.4.0''##On the next/master branches, bump up the version-number of simgear, flightgear and fgdata to an odd number (22016.4.0 -<u>1</u> 2.5.0)##Compile and test drive FlightGear with : Which release of the new development version number##Commit year the changes of version-number to next/master##Tag is (annotatednote: starts at 1) flightgear, simgear and fgdata with "version/2.5.0"##:* ''git tag -a version/2.5.0'Revision' (Enter a wise comment)##Push the branches next/master '''and''' release/2(2016.41.<u>0 '''and''' the tags upstream##</u>):for flighgear, simgear and fgdataIndicates one of two things: ''git push origin release/2.4.0''##:for flighgear, simgear and fgdata: ** In the ''git push origin version/2.4.0''##:for flighgear, simgear and fgdata: ''git push origin latest [[Git]] version/2.5.0''##:for flightgear and simgear: 'or 'git push origin next''##:for fgdata: [[FlightGear build server|nightly build]]''git push origin master''## declare dev-streams "open" or "green"##: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# Feb/Aug 17th: Create binaries/installers, pack fgdata, publish files, announce new version, close the release-branch##Tag the release/2.4.this digit is 0 branches of simgear, flightgear and fgdataindicating that it is unstable.##Merge the branch release/2.4.0 into ** When a new '''masterrelease''' (<u>'''NOT'''</u> next) for flightgear is created, this digit is set to 1. With bugfix that is made, this digit is increased by 1, and simgear##:We don't have a next branch for fgdata, no merging of the release branch herenew version created.
=== To bump up the version number ===* fgdata** edit the ''version'' file* SimGear** edit the ''version'' file* FlightGear** edit the ''version'' file** edit ''CMakeLists.txt''**: change the line '''find_package{{note|In general, release are referred to by their first two digits (SimGear 2e.5g.0 REQUIRED, 3.4)'''** edit ''src/Main/main.cxx''**: change However, when filing a bug report or debugging problems, it is a good idea to give the line '''static char required_version[] = "2.5full release number.0";'''}}
=== Definition of Stream States =Detailed time schedule and checklist ==* Open/Green: Normal development of # Just after the code base and fgdata. Unrestricted (wellnext release, sort of) access to the streams. This state lasts for five month after next default airport is decided on by a poll on the forum. The next release branches were createdwill be named after it.* Frozen/Yellow*:No new features or major changes shall be pushed onto the development streams # (neither source nor dataOn the 17th of the release month). This period : The first Jenkins script is for preparing the triggered to create <code for the >release and make sure there are no major issues/xxxx. It lasts x.0</code> branches with version xxxx.x.0.# Jenkins creates the binaries for four weeks until creation of xxxx.x.1.# Patches going into the <code>release branches/xxxx.* Closedx.0</Red*:Nothing shall be pushed to code> branch automatically trigger a new build with a increase of the development streams revision version number (simgear, flightgear see [[#2016.1 and fgdataafter|above]])and we immediately have a bugfix release. This state is for creating # On the release branches<code>next</code> branch, the version number is changed. It lasts for just a few hours on Jan 17th and Jul 17th around 12:00 UTC# Nightly builds are created from <code>next</code> after every push in that branch.
=== 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.4.0.A fix goes into release/2.4.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 The process is also solves an issue for the next version. Cherry-pick this commit into the release/2.4.0 branchrepeated after three months.
'''DO NOT''' merge == 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.48.0 or vice versaif the development of next has moved forward and this fix does not apply there. Most likely, It also goes into the release branch if there will be commits that are not welcome in or even break a better fix for next. A fix goes into next if it is also solves an issue for the other next version. Cherry-pick this commit into the release/2.8.0 branch.
=== Bug Tracking ===The [http:'''DO NOT''' merge next into release//flightgear-bugs2.googlecode8.com bugtracker] will be our primary source for the bug fixing period0 or vice versa. Bugs reported on the mailing list or forum Most likely, there 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 commits that can't be confirmed are not welcome in or need more input from even break the reporter to get fixed will be assigned a new state "stalled" and only processed after more information has been providedother branch. 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.->
=== Legacy =Bug tracking ==The current branch for the never release version 2[http://sourceforge.2.0 will be left untouched. No release will be created from this branch. The nextnet/p/master branches will receive a new development version number 2flightgear/codetickets/ bugtracker] is the primary source of bug reports.3.0 soon. The first release branch Unlike the forum or mailing list, bugs reported there will be created on Jultracked, 17th 2011making it easier for developers to keep up with them. The first freeze for When reporting bugs, it is best to provide as much information as possible to more easily find the branches will be announced on Jun, 17th 2011bug. If everything goes wellyou can provide a backtrace, Version 2please do so and attach it to the bug report.4.0 will be available around AugWhen creating backtraces, 18th 2011please use "thread apply all bt full" at the gdb command prompt.
<!-- === Tasks and Owners owners ===(taskowners not yet assigned)* Announce the state-change of the dev-streams* Create/maintain the git branches* Track the bugs on the tracker, trigger developers, adjust bug-priorities* Beta testing* Update documentation: [[FAQ]], [https://gitorious.org/fg/getstart GetStart], wiki* Pack RC and final version of FGDATA* Create the RC and final version (source-tarball)* Create the RC and final version for Linux* Create the RC and final version for Windows* Create the RC and final version for MacOS* Distribute files to download servers* Make adjustments on the web-site** Collect/make screenshots for the gallery* Announce the new version to the public** Write a changelog: [[Changelog 2.4.0]]** Contact flightsim websites and send them/link them to a "press release"
=== Open ItemsThe following table should be updated and augmented after each release, Questions =according to the [[Release plan#Lessons learned|Lessons learned]] section below. {| class="wikitable"! Stage! width="500px" | Task* <s>Can Jenkins create binaries ! Owner(RCs) from |-! rowspan="7" | Preparation| Announce the release branch?<state-change of the dev-streams, '''cross-post to JSBSim list''' (see lessons learned!)| TorstenD|-| Create/s> Binariesmaintain 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: yes[[FAQ]], installers[https: semiautomatic //www.gitorious.org/fg/getstart/ The Manual], wiki| Stuart, Gijs and anyone else|-| Pack RC and final version of fgdata||-! rowspan="5" | Create the RC and final version| Source-tarball| Curt|-| Linux| ThorstenB (for openSUSE)|-| Windows| Curt &amp; |-| MacOS| Tat)/James* <s>If not|-| 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, how often will we create RCGijs|-| 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]]</snowiki> Weekly* Surely | Hooray, Gijs, Stuart (other wiki admins)|-! rowspan="2" | Announce the beta testing rôle could/should be undertaken by selected members new version to the community public| Write a changelog: [[Next changelog]]| All developers/contributors|- selected based on their ability | Contact flightsim websites and send them/link them to write clearly the "press announcement". See [[release promotion]] for a list of already-contacted and yet-to write usefully-contact websites/magazines. (computer specifications, errors from the console| '''EVERYBODY'''|} == Open items, questions ==* Automate and other pieces /or document the creation of useful objective information - no subjective rot such as 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 doesnmore than once, automate it. If you can't workautomate 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* Surely not! The more people betaPossibly 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-test our 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 candidatesas well as thing that didn't turn out so well and should be changed for future releases. Ideally, the betterrelease plan should be updated and augmented so that the lessons learned are incorporated accordingly.<!-- {{Appendix}} --> == Related content ===== Mailing lists ===* {{cite web|url = http://sourceforge.net/p/flightgear/mailman/message/34701971/|title = <nowiki>[Flightgear-devel] Release 3.8</nowiki>|author = Torsten Dreyer|date = Dec 17th, 2015}} [[Category:Core developer documentation]][[Category:FlightGear]][[Category: Release]]

Navigation menu