From 83667430bcf2b36a3af653a971a5709adb8abd50 Mon Sep 17 00:00:00 2001 From: Doug Davis Date: Thu, 19 Nov 2020 15:40:36 +0000 Subject: [PATCH] talk about rc releases Signed-off-by: Doug Davis --- community/GOVERNANCE.md | 14 ++++++++++++++ spec.md | 7 +++++++ 2 files changed, 21 insertions(+) diff --git a/community/GOVERNANCE.md b/community/GOVERNANCE.md index 67340c22b..2d608fe4c 100644 --- a/community/GOVERNANCE.md +++ b/community/GOVERNANCE.md @@ -125,6 +125,20 @@ The specifications produced will adhere to the following: single logical unit and released at the same time, at the same version number. This is true regardless of whether each individual document actually changed during the release cycle. +- When a new release of a specification is ready, it will be given a version + number matching the appropriate semver version string but with a suffix of + `-rc#` (release candidate). This will indicate that the authors believe it + is ready for final release but it needs to go through a testing period to + allow for broader testing before it promoted to its final version number. + This will be true for updates to existing specifications and for new + specifications. +- Since changing the CloudEvents `specversion` string could have a significant + impact on implementations, all non-breaking changes will be made as + "patch" version updates - this allows for the value "on the wire" to remain + unchanged. If a breaking change is introduced the normal semver rules will + apply and the "major" version number will change. The net effect of this is + that the "minor" version number will always be zero and the `specversion` + string will always be of the form `X.0`. Note that these rules do not apply to the [documented extensions](../documented-extensions.md). diff --git a/spec.md b/spec.md index 1cc941e11..149a483ed 100644 --- a/spec.md +++ b/spec.md @@ -304,6 +304,13 @@ The following attributes are REQUIRED to be present in all CloudEvents: uses. This enables the interpretation of the context. Compliant event producers MUST use a value of `1.x-wip` when referring to this version of the specification. + + Currently, this attribute will only have the 'major' and 'minor' version + numbers included in it. This allows for 'patch' changes to the specification + to be made without changing this property's value in the serialization. + Note: for 'release candidate' releases a suffix might be used for testing + purposes. + - Constraints: - REQUIRED - MUST be a non-empty string