openstack
/
project-team-guide
Code Issues Proposed changes

Clarify deprecation tags and record deprecation cycle 

Currently project deprecation is done by keeping the
project in project.yaml but with release-management as
deprecated which is not enough to now is it really
deprecated in governance or just release. Also we do not
record the deprecation time so that we can remove the project
after deprecation is over.

Let's add a new deprecation field with deprecation cycle recorded.

Depends-On: https://review.opendev.org/#/c/736084/

Change-Id: I2b86bfd801ad9d1df8d0ab2d8f269fb922366895
This commit is contained in:
Ghanshyam Mann 2020-06-16 21:24:50 -05:00
parent 3b6ef189b1
commit 70d7f4a3aa
1 changed files with 25 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
doc/source/repository.rst
View File

@ -49,8 +49,8 @@ Submit a review to the ``openstack/requirements`` project removing the
project from ``projects.txt``. This needs to happen for stable
branches as well.
Steps 2-4: Remove Project from OpenDev and Retire it
----------------------------------------------------
Steps 2-4: Follow all three steps from OpenDev Manual
-----------------------------------------------------
Follow the steps about `Retiring a Project
<https://docs.opendev.org/opendev/infra-manual/latest/drivers.html#retiring-a-project>`_
@ -82,12 +82,23 @@ add it to the file ``reference/legacy.yaml`` in the
recently active, this may have implications for automatic detection of
ATCs.
Use Depends-On on ``project-config`` `final step patch
<https://docs.opendev.org/opendev/infra-manual/latest/drivers.html#step-3-remove-project-from-infrastructure-systems>`_.
Deprecating a Repository
========================
If you only want to stop development of the master branch but keep
stable branches, you need to do a slightly different approach.
Deprecating the project or repository is different than removal.
If the project want to stop the development on master branch but
support the stable branches with bug fixes, then project with
the `stable policy tag <https://governance.openstack.org/tc/reference/tags/stable_follows-policy.html>`
must be marked as deprecated. If project has no stable branch or does not
follow the stable policy tag then you have option to go with removal process
directly.
Step 1: Stop requirements syncing (if set up)
---------------------------------------------
@ -131,15 +142,7 @@ Once the project content is retired, revert the change you merged
earlier for ``project-config`` and re-add templates and jobs you need
so that you can merge content on stable branches.
Step 3: Mark the Repository as Deprecated in the Governance Repository
-----------------------------------------------------------------------
Mark the repository in the ``reference/projects.yaml`` file as
deprecated with adding a line::
release-management: deprecated
Step 4: Remove docs.openstack.org content
Step 3: Remove docs.openstack.org content
-----------------------------------------
Inform users that reach the ``docs.openstack.org`` page of your
@ -150,3 +153,14 @@ list in the file ``tools/www-generator.py`` in the
``openstack/openstack-manuals`` repository. Once the change merged,
the URL ``https://docs.openstack.org/openstack/<projectname>/latest``
will redirect to the repositories' ``README.rst`` file.
Step 4: Mark the Repository as Deprecated in the Governance Repository
-----------------------------------------------------------------------
Mark the repository in the ``reference/projects.yaml`` file as
deprecated with adding a line::
deprecated: <deprecated-cycle-name>
release-management: deprecated
Use Depends-On on ``project-config`` final step patch done in Step 2c.