From d15861b2ff7bac0fd8cd44228c8625977a4473f9 Mon Sep 17 00:00:00 2001 From: Brian Rosmaita Date: Fri, 12 Jan 2024 12:07:23 -0500 Subject: [PATCH] Clarify deliverable retirement step This is a followup to some comments on change I84490c186f2d. Change-Id: Id28612546e5551765c624d2964e41dbdd1a3ab22 --- doc/source/repository.rst | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/doc/source/repository.rst b/doc/source/repository.rst index 8f65a33..ac92989 100644 --- a/doc/source/repository.rst +++ b/doc/source/repository.rst @@ -144,8 +144,19 @@ NOTE: use Depends-On on ``governance`` patch submitted in Step 3. Step 8: Mark the deliverables as retired ---------------------------------------- -For maintained openstack series, on ``openstack/releases``, amend the related -deliverable files to tag the project with the ``retired`` flag. +Given that this project is being retired, there will be no more releases. +Thus you must do two tasks in the ``openstack/releases`` repository. + +First, completely remove the deliverable's yaml file from the directory +corresponding to the current development cycle. For example, if your +deliverable is ``puppet-panko`` and the current development cycle is +Ussuri, you must delete ``deliverables/ussuri/puppet-panko.yaml``. + +Next, if your deliverable has stable branches, for example, ``stable/train``, +you must amend the related deliverable files to tag the project with the +``retired`` flag. (We don't delete these yaml files because they contain +important historical information about the releases that have previously +occurred on these branches.) Example with ``deliverables/train/puppet-panko.yaml``:: @@ -164,6 +175,10 @@ Even if a project is retired, stable branches will continue to follow the existing series life cycle and this flag will allow us to ignore this deliverable in some specific cases. +For a complete example, here's the gerrit review that retired the +winstacker project's deliverables during the Bobcat development cycle: +https://review.opendev.org/c/openstack/releases/+/887238 + NOTE: use Depends-On on ``governance`` patch submitted in Step 3. Step 9: Update openstack-map to remove the retired project @@ -215,6 +230,10 @@ cycle is 2999.2 and the release nickname is "Xylophone". Submit a review to the ``openstack/releases`` repository that removes the deliverable's yaml file from the ``deliverables/xylophone/`` directory. +For a recent example, here's the gerrit review that deprecated +cinderlib's deliverables during the Caracal development cycle: +https://review.opendev.org/c/openstack/releases/+/904862 + NOTE: use Depends-On on ``governance`` patch submitted in Step 1. Step 4: Retire master branch