From 4128728f51bb0542b3a577f76b42ee2af8965083 Mon Sep 17 00:00:00 2001
From: Amir MOHAMMADI <amir.mohammadi@idiap.ch>
Date: Wed, 22 Jun 2022 18:21:23 +0200
Subject: [PATCH] Add more notes and warnings about releases
---
doc/release.rst | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/doc/release.rst b/doc/release.rst
index 9484d5cb..41bd94cd 100644
--- a/doc/release.rst
+++ b/doc/release.rst
@@ -13,6 +13,12 @@ for the release build and documentation badges. The tools are setup to ensure a
changelog is provided with each release. The changelog can be autogenerated
from merge-requests or commits in the target package.
+.. warning::
+
+ Releasing any package that is listed in the nightlies repository requires a
+ green nightlies after all changes have been merged to the master branches of
+ all packages. Do not release a package because it is green by itself. Its
+ compatibility must be tested against all other packages first.
Usage
=====
@@ -27,6 +33,11 @@ Releasing Bob is a 4-step process:
Use the ``--help`` flag in each command to learn more about each command.
+.. note::
+
+ If the package that you are releasing is not part of the nightlies
+ repository, you can skip steps 3 and 4.
+
.. warning::
While *beta* builds of packages will use the beta version of this package,
--
GitLab