openstack/releases
Code Issues Proposed changes

Update list_eol_stale_branches.sh documentation

Browse Source 
With the new option of the script (delete a branch) the documentation
is updated to express this as well.

Change-Id: I9445b4f8abff81c11a397a15a85cb1ffe1e5bfec
This commit is contained in:
Előd Illés 2021-03-04 13:27:54 +01:00 committed by Elod Illes
parent e44220de88
commit e142f4a110
1 changed files with 18 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/source/reference/using.rst
View File

@ -819,7 +819,8 @@ For more usage and examples:
tools/list_eol_stale_branches.sh
---------------------------------
A script to detect deliverables who have eol stale branches in their repos.
A script to detect deliverables who have EOL stale branches and optionally
delete them.
Example:
@ -827,11 +828,22 @@ Example:
tools/list_eol_stale_branches.sh
The reason behind this tool is that since the extended maintenance model
have been introduced we stopped removing automatically EOL branches when a
deliverable become EOL, this tool aim to list projects that have been declared
EOL on a series that is EM and where the corresponding series branch
still exists.
Another example with predefining the gerrit user to be used for branch deletion:
::
GERRIT_USER=<gerrit_user_name> tools/list_eol_stale_branches.sh
The reason behind this tool is that since the Extended Maintenance model
have been introduced we stopped removing automatically End of Life (EOL)
branches. This tool aims to list projects with branches that have been
declared ``End of Life`` (that is, tagged with ``$series-eol``), but the
corresponding series branch still exists. The script also offers to delete
these stale branches.
.. note::
Only release managers have the access rights to delete branches.
tools/list_unbranched_projects.sh
---------------------------------