summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@gnutls.org>2019-05-26 21:35:19 +0200
committerNikos Mavrogiannopoulos <nmav@gnutls.org>2019-05-26 21:53:16 +0200
commitefeb175a7fc47957ec0d6b3984118638a4199f6d (patch)
treee956f48cc9dad2f6789d0afe64e35bbbd2601a48
parentb7e56693a937f7fda5d825093bea8952c506ef8c (diff)
downloadgnutls-tmp-releases.tar.gz
RELEASES.md: document the releases policy [ci skip]tmp-releases
This adds a file to document the policy on releases based on the discussions taken place in the last face to face meeting. https://gitlab.com/gnutls/gnutls/wikis/face2face-meeting-fosdem2019 Signed-off-by: Nikos Mavrogiannopoulos <nmav@gnutls.org>
-rw-r--r--CONTRIBUTING.md2
-rw-r--r--Makefile.am2
-rw-r--r--README.md7
-rw-r--r--RELEASES.md18
4 files changed, 22 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3a20170f6b..081d9f1b3e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -178,7 +178,7 @@ should be introduced to enable the new behavior.
When it is necessary, or desireable to enable the new features by default
(e.g., TLS1.3 introduction), the "next" releases should be used (and
introduced if necessary), to allow the modification to be tested for an
-extended amount of time.
+extended amount of time (see the [Release policy](RELEASES.md)).
# API documentation
diff --git a/Makefile.am b/Makefile.am
index ffcbc4ee5d..a352ca4dfc 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -60,7 +60,7 @@ endif
ACLOCAL_AMFLAGS = -I m4 -I src/libopts/m4 -I src/gl/m4 -I lib/unistring/m4 --install
EXTRA_DIST = cfg.mk maint.mk CONTRIBUTING.md README.md LICENSE AUTHORS NEWS \
- ChangeLog THANKS INSTALL.md
+ ChangeLog THANKS INSTALL.md RELEASES.md
DISTCLEANFILES = AUTHORS
diff --git a/README.md b/README.md
index a834b7a931..64ca34f99e 100644
--- a/README.md
+++ b/README.md
@@ -2,11 +2,8 @@
|Branch|CI system|Status|Coverage|
|:----:|:-------:|-----:|:------:|
-|Master|Gitlab|[![build status](https://gitlab.com/gnutls/gnutls/badges/master/build.svg)](https://gitlab.com/gnutls/gnutls/commits/master)|[![coverage report](https://gitlab.com/gnutls/gnutls/badges/master/coverage.svg)](https://gnutls.gitlab.io/coverage/master)|
-|Master|Travis|[![build status](https://travis-ci.org/gnutls/gnutls.svg?branch=master)](https://travis-ci.org/gnutls/gnutls)|N/A|
-|3.5.x|Gitlab|[![build status](https://gitlab.com/gnutls/gnutls/badges/gnutls_3_5_x/build.svg)](https://gitlab.com/gnutls/gnutls/commits/gnutls_3_5_x)|[![coverage report](https://gitlab.com/gnutls/gnutls/badges/gnutls_3_5_x/coverage.svg)](https://gnutls.gitlab.io/coverage/3.5.x)|
-|3.5.x|Travis|[![build status](https://travis-ci.org/gnutls/gnutls.svg?branch=gnutls_3_5_x)](https://travis-ci.org/gnutls/gnutls)|N/A|
-|3.3.x|Gitlab|[![build status](https://gitlab.com/gnutls/gnutls/badges/gnutls_3_3_x/build.svg)](https://gitlab.com/gnutls/gnutls/commits/gnutls_3_3_x)|N/A|
+|Master/3.6.x|Gitlab|[![build status](https://gitlab.com/gnutls/gnutls/badges/master/build.svg)](https://gitlab.com/gnutls/gnutls/commits/master)|[![coverage report](https://gitlab.com/gnutls/gnutls/badges/master/coverage.svg)](https://gnutls.gitlab.io/coverage/master)|
+|Master/3.6.x|Travis|[![build status](https://travis-ci.org/gnutls/gnutls.svg?branch=master)](https://travis-ci.org/gnutls/gnutls)|N/A|
# GnuTLS -- Information for developers
diff --git a/RELEASES.md b/RELEASES.md
new file mode 100644
index 0000000000..c0a840c2c5
--- /dev/null
+++ b/RELEASES.md
@@ -0,0 +1,18 @@
+# Release policy
+
+In the GnuTLS project there are at most two ongoing releases, one marked as
+'stable' and one marked as 'next'. The former is always present and
+supported, while the latter is introduced on the discretion of the
+development team.
+
+For both release branches all the rules in [CONTRIBUTING.md](CONTRIBUTING.md)
+apply, but in principle the 'stable' release is more conservative in new features,
+while the 'next' branch allows for mild behavioral changes. The 'stable' branch
+always provides API and ABI compatibility, while the 'next' branch may on exceptional
+cases change the API.
+
+
+|Branch|Version|Release interval|
+|:----:|:-----:|:--------------:|
+|stable|3.6.x |bi-monthly |
+|next |- | |