Release plan: Difference between revisions
mNo edit summary |
|||
(256 intermediate revisions by 19 users not shown) | |||
Line 1: | Line 1: | ||
{{GitStatus}} | |||
{{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. | ||
[[File:ReleasePlan.jpg|thumb|250px|The original release plan.]] | |||
FlightGear has had two release plans over [[FlightGear History|history]]. 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 3.6 release was [[FlightGear Newsletter November 2015#FlightGear v3.6 canceled|cancelled]]. | |||
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. | |||
== General release concept == | |||
A new version of FlightGear is released every three months, meaning four releases per year. On the 17th of the month, new release branches are created and the [[build server]] creates the binaries and uploading them to SourceForge. If any changes are made to the release branch, a new bugfix release is created. The version of the <code>next</code> branch is incremented. And development coninutes as normal, with new nightly builds be created after each change. The table below shows the release cycle. See also [http://sourceforge.net/p/flightgear/mailman/message/34701971/ this mailing list post]. | |||
{| class="wikitable" | |||
! Month !! Number in cycle | |||
|- | |||
| January | |||
| style="background-color: #e55757" | 4 ''(previous year)'' | |||
|- | |||
| February | |||
| style="background-color: #e4ae3a" | 1 | |||
|- | |||
| 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 == | |||
FlightGear version numbers consist of three digits, separated by dots: | |||
=== Before 2016.1 === | |||
* '''Major''' (<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). | |||
=== | === 2016.1 and after === | ||
* '''Year''' (<u>2016</u>.1.0): The year the version was released. | |||
* '''Number''' (2016.<u>1</u>.0): Which release of the year the version is (note: starts at 1). | |||
* '''Revision''' (2016.1.<u>0</u>): Indicates one of two things: | |||
** In the '''latest [[Git]] version''' or '''[[FlightGear build server|nightly build]]''', this digit is 0, indicating that it is unstable. | |||
** When a new '''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.}} | |||
== | == Detailed time schedule and checklist == | ||
# 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. | |||
# (On the 17th of the release month): The first Jenkins script is triggered to create <code>release/xxxx.x.0</code> branches with version xxxx.x.0. | |||
# Jenkins creates the binaries for xxxx.x.1. | |||
# Patches going into the <code>release/xxxx.x.0</code> branch automatically trigger a new build with a increase of the revision version number (see [[#2016.1 and after|above]]) and we immediately have a bugfix release. | |||
# On the <code>next</code> branch, the version number is changed. | |||
# Nightly builds are created from <code>next</code> after every push in that branch. | |||
The process is repeated after three months. | |||
=== Bug fix committing policy | == Version files == | ||
Fixes for bugs during the shakedown test of the release branch may be applied to the branches next or release/2. | ; FGData: {{fgdata file|version}} | ||
A fix goes into release/2. | ; SimGear: {{simgear file|version}} | ||
A fix goes into next if it is also solves an issue for the next version. Cherry-pick this commit into the release/2. | ; 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. | |||
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. | '''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://flightgear | 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. | ||
<!-- | |||
=== 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. | |||
The | |||
== | {| class="wikitable" | ||
( | ! Stage | ||
! width="500px" | Task | |||
! Owner(s) | |||
|- | |||
! 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 fgdata | |||
| | |||
|- | |||
! rowspan="5" | Create the RC and final version | |||
| Source-tarball | |||
| Curt | |||
|- | |||
| Linux | |||
| ThorstenB (for openSUSE) | |||
|- | |||
| Windows | |||
| 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§ion=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: [[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/magazines. | |||
| '''EVERYBODY''' | |||
|} | |||
== Open items, questions == | |||
* Automate the creation of | * 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 | * 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}} --> | ||
== 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]] |
Revision as of 13:36, 21 February 2020
Current release: 2020.3.19 (18 Oct 2023) Next release: 2020.3.20 See release plan for details. |
Release process |
---|
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.
FlightGear has had two release plans over history. 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 3.6 release was cancelled.
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.
General release concept
A new version of FlightGear is released every three months, meaning four releases per year. On the 17th of the month, new release branches are created and the build server creates the binaries and uploading them to SourceForge. If any changes are made to the release branch, a new bugfix release is created. The version of the next
branch is incremented. And development coninutes as normal, with new nightly builds be created after each change. The table below shows the release cycle. See also this mailing list post.
Month | Number in cycle |
---|---|
January | 4 (previous year) |
February | 1 |
March | 1 |
April | 1 |
May | 2 |
June | 2 |
July | 2 |
August | 3 |
September | 3 |
October | 3 |
November | 4 |
December | 4 |
Version numbers
FlightGear version numbers consist of three digits, separated by dots:
Before 2016.1
- Major (3.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.4.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 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.0): Increased by bugfix releases (e.g., 2.12.1).
2016.1 and after
- Year (2016.1.0): The year the version was released.
- Number (2016.1.0): Which release of the year the version is (note: starts at 1).
- Revision (2016.1.0): Indicates one of two things:
- In the latest Git version or nightly build, this digit is 0, indicating that it is unstable.
- When a new 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. |
Detailed time schedule and checklist
- 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.
- (On the 17th of the release month): The first Jenkins script is triggered to create
release/xxxx.x.0
branches with version xxxx.x.0. - Jenkins creates the binaries for xxxx.x.1.
- Patches going into the
release/xxxx.x.0
branch automatically trigger a new build with a increase of the revision version number (see above) and we immediately have a bugfix release. - On the
next
branch, the version number is changed. - Nightly builds are created from
next
after every push in that branch.
The process is repeated after three months.
Version files
- FGData
- fgdata/version
- SimGear
- simgear/version
- FlightGear
- flightgear/version
- FGRun
- fgrun/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.
Related content
Mailing lists
- Torsten Dreyer (Dec 17th, 2015). [Flightgear-devel] Release 3.8.