tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 12:05:37 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #8048 from open-sausages/pulls/4/docs-release-proc

Browse Source 
Release process docs improvements
This commit is contained in:
Robbie Averill 2018-05-08 11:25:15 +12:00 committed by GitHub
commit fe5a271634
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/en/05_Contributing/04_Release_Process.md
View File

@ -2,43 +2,47 @@ summary: Describes the process followed for "core" releases.
# Release Process # Release Process
This page describes the process followed for "core" releases (mainly the `framework` and `cms` modules). This page describes the process followed for "core" releases
(the modules included by [silverstripe/recipe-core](https://github.com/silverstripe/recipe-core)
and [silverstripe/recipe-cms](https://github.com/silverstripe/recipe-cms)).
## Release Planning ## Release Planning
Releases are planned by assigning issues to GitHub milestones. Releases are planned by assigning issues to GitHub milestones,
according to our [roadmap](http://silverstripe.org/roadmap).
SilverStripe is split up into many modules listed on [github.com/silverstripe](https://github.com/silverstripe). SilverStripe is split up into many modules listed on [github.com/silverstripe](https://github.com/silverstripe).
Each of them will have its own milestones and issues, and different release lines (e.g. 1.x vs. 4.x). Each of them will have its own milestones and issues, and different release lines (e.g. 1.x vs. 4.x).
There are high-level "recipe" milestones on the [framework repository](https://github.com/silverstripe/silverstripe-framework/milestones) There are high-level "recipe" milestones on the [framework repository](https://github.com/silverstripe/silverstripe-framework/milestones)
to combine individual module milestones into a larger release that's eventually available on to combine individual module milestones into a larger release that's eventually available on
[silverstripe.org/download](https://silverstripe.org/download). [silverstripe.org/download](https://silverstripe.org/download).
New features and API changes are discussed on the [core mailinglist](http://groups.google.com/group/silverstripe-dev). They are prioritised by the core team as tickets on New features and API changes are discussed as
[GitHub issues](https://docs.silverstripe.org/en/contributing/issues_and_bugs/)),
as well as the [forum](https://forum.silverstripe.org).
They are prioritised by the core team as tickets on
github.com. In addition, we collect community feedback on [silverstripe.uservoice.com](https://silverstripe.uservoice.com). github.com. In addition, we collect community feedback on [silverstripe.uservoice.com](https://silverstripe.uservoice.com).
Any feature ideas we're planning to implement will be flagged there. Any feature ideas we're planning to implement will be flagged there.
Release dates are usually not published prior to the release, but you can get a good idea of the release status by Release dates are usually not published prior to the release, but you can get a good idea of the release status by
reviewing the release milestone on github.com. Releases will be reviewing the release milestone on github.com. Releases will be
announced on the [release announcements mailing list](http://groups.google.com/group/silverstripe-announce). announced on the ["releases" forum category](https://forum.silverstripe.org/c/releases).
## Release Numbering ## Release Numbering
SilverStripe follows [Semantic Versioning](http://semver.org). SilverStripe follows [Semantic Versioning](http://semver.org).
Note: Until November 2014, the project didn't adhere to Semantic Versioning. Instead, a "minor release" in semver terminology
was treated as a "major release" in SilverStripe. For example, the *3.1.0* release contained API breaking changes, and
the *3.1.1* release contained new features rather than just bugfixes.
## Supported versions ## Supported versions
Our version support is outlined on [silverstripe.org/roadmap](http://silverstripe.org/roadmap).
At any point in time, the core development team will support a set of releases to varying levels: At any point in time, the core development team will support a set of releases to varying levels:
* The current *master* will get new features, bug fixes and API changes that might require major refactoring before going * The current *master* will get new features, bug fixes and API changes that might require major refactoring before going
into a release. At the moment, bugfixing and feature development might happen on the current major release branch (e.g. *3*), to be into a release. At the moment, bugfixing and feature development might happen on the current major release branch (e.g. *4*), to be
merged forward to master regularly. merged forward to master regularly.
* Applicable bugfixes on master will also be merged back to the last major release branch, to be released as the next * Applicable bugfixes on master will also be merged back to the last major release branch, to be released as the next
patch release patch release
* Security fixes will be applied to the current master and the previous two major releases (e.g. *4.0*, *3.2* and *3.1*). * Security fixes will be applied to the current master,
as well as patch releases for SilverStripe versions in "active development", "full support" or "limited support".
## Deprecation ## Deprecation
@ -124,7 +128,7 @@ timeline and ask the reporter to keep the issue confidential until we announce i
* Halt all other development as long as is needed to develop a fix, including patches against the current and one * Halt all other development as long as is needed to develop a fix, including patches against the current and one
previous major release (if applicable). previous major release (if applicable).
* Pre-announce the upcoming security release to a private mailing list of important stakeholders (see below). * Pre-announce the upcoming security release to a private mailing list of important stakeholders (see below).
* We will inform you about resolution and [announce](http://groups.google.com/group/silverstripe-announce) a * We will inform you about resolution and [announce](https://forum.silverstripe.org/c/releases) a
[new release](http://silverstripe.org/security-releases/) publically. [new release](http://silverstripe.org/security-releases/) publically.
You can help us determine the problem and speed up responses by providing us with more information on how to reproduce You can help us determine the problem and speed up responses by providing us with more information on how to reproduce