opendev/infra-manual
Code Issues Proposed changes

Merge "Remove OpenStack specific steps from project retirement/rename"

Browse Source
This commit is contained in:
Zuul 2020-03-11 20:29:06 +00:00 committed by Gerrit Code Review
commit c6d8b04c2d
2 changed files with 8 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/source/creators.rst
View File

@ -1471,28 +1471,8 @@ branches like ``stable/mitaka``. It will not run on the old
Project Renames Project Renames
=============== ===============
.. note:: When preparing to rename a project, make changes to the files in the
``openstack/project-config`` repository related to your project.
If you rename a project to move out from "openstack" namespace to
any other namespace, follow `this OpenStack TC resolution
<https://governance.openstack.org/tc/resolutions/20190711-mandatory-repository-retirement.html>`_
instead.
The first step of doing a rename is understanding the required
governance changes needed by the rename. You can use the following
criteria:
For a project being added to existing official OpenStack project:
Create an ``openstack/governance`` change and add a "Depends-On:
project-change-url" of the change you make in the following steps to
the commit message, and add a comment in the
``openstack/project-config`` change that references the
governance change. You will also make sure the PTL has expressed
approval for the addition in some way.
When preparing to rename a project, begin by making changes to the
files in the ``openstack/project-config`` repository related
to your project.
When uploading your change, make sure the topic is "project-rename" When uploading your change, make sure the topic is "project-rename"
which can be done by submitting the review with the following which can be done by submitting the review with the following
@ -1519,9 +1499,6 @@ Post rename, a member of the Infrastructure team will submit a patch to update
the :file:`.gitreview` file in the renamed project to point to the new project the :file:`.gitreview` file in the renamed project to point to the new project
name. name.
Other projects you may need to update post-rename:
* projects.txt in ``openstack/requirements``
Review List for New Projects Review List for New Projects
============================ ============================

28
doc/source/drivers.rst
View File

@ -307,9 +307,9 @@ following steps will help you wind down a project gracefully.
.. note:: .. note::
The following sections are really separate steps. If your project The following sections are really separate steps. If your project
has jobs set up and is an official project, you need to submit has jobs set up, you need to submit several different changes as
*four* different changes as explained below. We recommend to link explained below. We recommend to link these changes with
these changes with "Depends-On:" and "Needed-By:" headers. "Depends-On:" and "Needed-By:" headers.
Prerequirement: Announce Retirement Prerequirement: Announce Retirement
----------------------------------- -----------------------------------
@ -318,14 +318,7 @@ Use mailing lists or other channels to announce to users and
contributors that the project is being retired. Be sure to include a contributors that the project is being retired. Be sure to include a
date upon which maintenance will end, if that date is in the future. date upon which maintenance will end, if that date is in the future.
Step 1: Stop requirements syncing (if set up) Step 1: End Project Gating
---------------------------------------------
Submit a review to the ``openstack/requirements`` project removing the
project from ``projects.txt``. This needs to happen for stable
branches as well.
Step 2: End Project Gating
-------------------------- --------------------------
Check out a copy of the ``openstack/project-config`` repository Check out a copy of the ``openstack/project-config`` repository
@ -346,7 +339,7 @@ Submit that change and make sure to mention in the commit message that
you are ending project gating for the purposes of retiring the you are ending project gating for the purposes of retiring the
project. Wait for that change to merge and then proceed. project. Wait for that change to merge and then proceed.
Step 3: Remove Project Content Step 2: Remove Project Content
------------------------------ ------------------------------
Once Zuul is no longer running tests on your project, prepare a change Once Zuul is no longer running tests on your project, prepare a change
@ -390,7 +383,7 @@ deploy unmaintained software. Potential contributors who may not have
otherwise read the README will in this case, as it is the only file in otherwise read the README will in this case, as it is the only file in
the repository. the repository.
Step 4: Remove Project from Infrastructure Systems Step 3: Remove Project from Infrastructure Systems
-------------------------------------------------- --------------------------------------------------
Once your repository is in its final state, prepare a second change to Once your repository is in its final state, prepare a second change to
@ -428,15 +421,6 @@ following:
team to restore the project status back to "Active" in Gerrit before ACLs team to restore the project status back to "Active" in Gerrit before ACLs
can be reapplied successfully. can be reapplied successfully.
Step 5: Remove Repository from the Governance Repository
--------------------------------------------------------
If this was an official OpenStack project, remove it from the
``reference/projects.yaml`` file and add it to the file
``reference/legacy.yaml`` in the ``openstack/governance`` repository.
Note that if the project was recently active, this may have
implications for automatic detection of ATCs.
Package Requirements Package Requirements
==================== ====================