From cdb926d3df7ca6c00700f05e04e064f18fa1ba26 Mon Sep 17 00:00:00 2001 From: Evan Read Date: Fri, 18 Jan 2019 13:34:18 +1000 Subject: Provide more information of release cadence --- doc/policy/maintenance.md | 34 +++++++++++++++------------------- 1 file changed, 15 insertions(+), 19 deletions(-) diff --git a/doc/policy/maintenance.md b/doc/policy/maintenance.md index 1b93cdb83ac..a16c7dcda9b 100644 --- a/doc/policy/maintenance.md +++ b/doc/policy/maintenance.md @@ -3,21 +3,21 @@ ## Versioning GitLab follows the [Semantic Versioning](http://semver.org/) for its releases: -`(Major).(Minor).(Patch)` in a [pragmatic way]. - -- **Major version**: Whenever there is something significant or any backwards - incompatible changes are introduced to the public API. -- **Minor version**: When new, backwards compatible functionality is introduced - to the public API or a minor feature is introduced, or when a set of smaller - features is rolled out. -- **Patch number**: When backwards compatible bug fixes are introduced that fix - incorrect behavior. +`(Major).(Minor).(Patch)` in a [pragmatic way](https://gist.github.com/jashkenas/cbd2b088e20279ae2c8e). For example, for GitLab version 10.5.7: -- `10` represents major version -- `5` represents minor version -- `7` represents patch number +- `10` represents major version. +- `5` represents minor version. +- `7` represents patch number. + +The following table describes the versions and their release cadence: + +| Version type | Cadence | Description | +|:-------------|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Major | Yearly | For significant changes, or when any backwards incompatible changes are introduced to the public API. | +| Minor | Monthly | For when new backwards compatible functionality is introduced to the public API, a minor feature is introduced, or when a set of smaller features is rolled out. | +| Patch | As needed | For backwards compatible bug fixes that fix incorrect behavior. See [Patch releases](#patch-releases). | ## Patch releases @@ -68,7 +68,7 @@ We cannot guarantee that upgrading between major versions will be seamless. As p We recommend that you first upgrade to the latest available minor version within your major version. By doing this, you can address any deprecation messages -that could possibly change behaviour in the next major release. +that could change behavior in the next major release. Please see the table below for some examples: @@ -79,9 +79,5 @@ Please see the table below for some examples: | 11.3.4 | 8.13.4 | `8.13.4` -> `8.17.7` -> `9.5.10` -> `10.8.7` -> `11.3.4` | `8.17.7` is the last version in version `8`, `9.5.10` is the last version in version `9`, `10.8.7` is the last version in version `10` | More information about the release procedures can be found in our -[release-tools documentation][rel]. You may also want to read our -[Responsible Disclosure Policy][disclosure]. - -[rel]: https://gitlab.com/gitlab-org/release-tools/blob/master/doc/ -[disclosure]: https://about.gitlab.com/disclosure/ -[pragmatic way]: https://gist.github.com/jashkenas/cbd2b088e20279ae2c8e +[release documentation](https://gitlab.com/gitlab-org/release/docs). You may also want to read our +[Responsible Disclosure Policy](https://about.gitlab.com/disclosure/). -- cgit v1.2.1 From 95ca18627fc4a32a6ae800483ccf65e290031877 Mon Sep 17 00:00:00 2001 From: Mike Lewis Date: Fri, 18 Jan 2019 18:51:49 +0000 Subject: Minor edits to wording and links --- doc/policy/maintenance.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/policy/maintenance.md b/doc/policy/maintenance.md index a16c7dcda9b..9ebd61cc6f5 100644 --- a/doc/policy/maintenance.md +++ b/doc/policy/maintenance.md @@ -15,9 +15,9 @@ The following table describes the versions and their release cadence: | Version type | Cadence | Description | |:-------------|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Major | Yearly | For significant changes, or when any backwards incompatible changes are introduced to the public API. | -| Minor | Monthly | For when new backwards compatible functionality is introduced to the public API, a minor feature is introduced, or when a set of smaller features is rolled out. | -| Patch | As needed | For backwards compatible bug fixes that fix incorrect behavior. See [Patch releases](#patch-releases). | +| Major | Yearly | For significant changes, or when any backward-incompatible changes are introduced to the public API. | +| Minor | Monthly | For when new backward-compatible functionality is introduced to the public API, a minor feature is introduced, or when a set of smaller features is rolled out. | +| Patch | As needed | For backward-compatible bug fixes that fix incorrect behavior. See [Patch releases](#patch-releases). | ## Patch releases @@ -80,4 +80,4 @@ Please see the table below for some examples: More information about the release procedures can be found in our [release documentation](https://gitlab.com/gitlab-org/release/docs). You may also want to read our -[Responsible Disclosure Policy](https://about.gitlab.com/disclosure/). +[Responsible Disclosure Policy](https://about.gitlab.com/security/disclosure/). -- cgit v1.2.1 From e60c825414ba41f52ba5866930384dcd200c7da9 Mon Sep 17 00:00:00 2001 From: Mike Lewis Date: Fri, 18 Jan 2019 19:23:31 +0000 Subject: Edit table to be more explicit about when the releases are --- doc/policy/maintenance.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/policy/maintenance.md b/doc/policy/maintenance.md index 9ebd61cc6f5..601b6093110 100644 --- a/doc/policy/maintenance.md +++ b/doc/policy/maintenance.md @@ -11,13 +11,13 @@ For example, for GitLab version 10.5.7: - `5` represents minor version. - `7` represents patch number. -The following table describes the versions and their release cadence: +The following table describes the version types and their release cadence: -| Version type | Cadence | Description | +| Version type | Description | Cadence | |:-------------|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Major | Yearly | For significant changes, or when any backward-incompatible changes are introduced to the public API. | -| Minor | Monthly | For when new backward-compatible functionality is introduced to the public API, a minor feature is introduced, or when a set of smaller features is rolled out. | -| Patch | As needed | For backward-compatible bug fixes that fix incorrect behavior. See [Patch releases](#patch-releases). | +| Major | For significant changes, or when any backward-incompatible changes are introduced to the public API. | Yearly. The next major release is GitLab 12.0 on May 22, 2019. As of June 2020, major releases will occur each year on June 22. | | +| Minor | For when new backward-compatible functionality is introduced to the public API, a minor feature is introduced, or when a set of smaller features is rolled out. | Monthly on the 22nd. | +| Patch | For backward-compatible bug fixes that fix incorrect behavior. See [Patch releases](#patch-releases). | As needed. | ## Patch releases -- cgit v1.2.1 From 856c2f2ff3270ae2be6f25f9a535916ebcd92a10 Mon Sep 17 00:00:00 2001 From: Mike Lewis Date: Sat, 19 Jan 2019 03:01:47 +0000 Subject: Update language on annual release date --- doc/policy/maintenance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/policy/maintenance.md b/doc/policy/maintenance.md index 601b6093110..390db637031 100644 --- a/doc/policy/maintenance.md +++ b/doc/policy/maintenance.md @@ -15,7 +15,7 @@ The following table describes the version types and their release cadence: | Version type | Description | Cadence | |:-------------|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Major | For significant changes, or when any backward-incompatible changes are introduced to the public API. | Yearly. The next major release is GitLab 12.0 on May 22, 2019. As of June 2020, major releases will occur each year on June 22. | | +| Major | For significant changes, or when any backward-incompatible changes are introduced to the public API. | Yearly. The next major release is GitLab 12.0 on June 22, 2019. Subsequent major releases will be scheduled for May 22 each year. | | | Minor | For when new backward-compatible functionality is introduced to the public API, a minor feature is introduced, or when a set of smaller features is rolled out. | Monthly on the 22nd. | | Patch | For backward-compatible bug fixes that fix incorrect behavior. See [Patch releases](#patch-releases). | As needed. | -- cgit v1.2.1 From 1de38289e2fff116970febc50111b92d5ec877ff Mon Sep 17 00:00:00 2001 From: Mike Lewis Date: Sat, 19 Jan 2019 17:49:13 +0000 Subject: Added 'by default' re. annual major-release date scheduling --- doc/policy/maintenance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/policy/maintenance.md b/doc/policy/maintenance.md index 390db637031..6c3ad080e3e 100644 --- a/doc/policy/maintenance.md +++ b/doc/policy/maintenance.md @@ -15,7 +15,7 @@ The following table describes the version types and their release cadence: | Version type | Description | Cadence | |:-------------|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Major | For significant changes, or when any backward-incompatible changes are introduced to the public API. | Yearly. The next major release is GitLab 12.0 on June 22, 2019. Subsequent major releases will be scheduled for May 22 each year. | | +| Major | For significant changes, or when any backward-incompatible changes are introduced to the public API. | Yearly. The next major release is GitLab 12.0 on June 22, 2019. Subsequent major releases will be scheduled for May 22 each year, by default. | | | Minor | For when new backward-compatible functionality is introduced to the public API, a minor feature is introduced, or when a set of smaller features is rolled out. | Monthly on the 22nd. | | Patch | For backward-compatible bug fixes that fix incorrect behavior. See [Patch releases](#patch-releases). | As needed. | -- cgit v1.2.1 From 5f902f1c89ffd6780f3efbe9afdebbef175fbb46 Mon Sep 17 00:00:00 2001 From: Mike Lewis Date: Wed, 23 Jan 2019 01:32:38 +0000 Subject: Add clarity around meaning and potential range of version numbers --- doc/policy/maintenance.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/policy/maintenance.md b/doc/policy/maintenance.md index 6c3ad080e3e..1d656574acd 100644 --- a/doc/policy/maintenance.md +++ b/doc/policy/maintenance.md @@ -7,9 +7,11 @@ GitLab follows the [Semantic Versioning](http://semver.org/) for its releases: For example, for GitLab version 10.5.7: -- `10` represents major version. -- `5` represents minor version. -- `7` represents patch number. +- `10` represents the major version. The major release was 10.0.0, but often referred to as 10.0. +- `5` represents the minor version. The minor release was 10.5.0, but often referred to as 10.5. +- `7` represents the patch number. + +Any part of the version number can increment into multiple digits, for example, 13.10.11. The following table describes the version types and their release cadence: -- cgit v1.2.1