Add list_eom_stale_branches.sh

This is based on the list_eol_stale_branches.sh script to make it
possible to delete stable/<series> branches where there are
<series>-eom tag already.

Change-Id: Iaaa9702c5b304152492ed2afc56ac07fb9c9fb98
This commit is contained in:
Előd Illés 2024-02-01 23:19:21 +01:00 committed by Elod Illes
parent 88f298c6bc
commit 97e76562e0
2 changed files with 160 additions and 0 deletions

View File

@ -840,6 +840,29 @@ 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_eom_stale_branches.sh
---------------------------------
A script to detect deliverables that have EOM stale branches and optionally
delete them.
Example:
::
tools/list_eom_stale_branches.sh <series>
With the new process changes maintained branches don't move into
Extended Maintenance anymore, but into Unmaintained phase. The HEAD of
the stable branches are tagged with <series>-eom tag and a branch
called unmaintained/<series> is cut from that tag. The stable/<series>
branch needs to be deleted afterwards.
This script list these stable/branches and offers to delete them.
.. note::
Only release managers have the access rights to delete branches.

137
tools/list_eom_stale_branches.sh Executable file
View File

@ -0,0 +1,137 @@
#!/bin/bash
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
# This script helps to find and delete stable/<series> branches tagged with
# <series>-eom tag, when the given series transitions to Unmaintained.
function help {
# Display helping message
cat <<EOF
usage: $0 <series> [<args>]
Provide a list of repositories that contains eom stale branches on a
series, and give option to delete them.
Arguments:
<series> The <series> that is to move to Unmaintained
-d, --debug Turn on the debug mode
-h, --help show this help message and exit
examples:
$(basename $0)
EOF
}
for i in "$@"; do
case $i in
# Turn on the debug mode
-d|--debug)
set -x
shift 1
;;
# Display the helping message
-h|--help)
help
exit 0
;;
esac
done
if [[ "$1" == "" ]]; then
help
exit 1
fi
SERIES=$1
gerrit_username=${GERRIT_USER:-}
GERRIT_URL="https://review.opendev.org"
TOOLSDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
BASEDIR=$(dirname $TOOLSDIR)
source $TOOLSDIR/functions
enable_tox_venv
# Make sure no pager is configured so the output is not blocked
export PAGER=
setup_temp_space 'list-eom-stale-branches'
branch=$(series_to_branch "$series")
function no_open_patches {
req="${GERRIT_URL}/changes/?q=status:open+project:${repo}+branch:stable/${SERIES}"
patches=$(curl -s ${req} | sed 1d | jq --raw-output '.[] | .change_id')
[ -z "${patches}" ]
no_opens=$?
if [[ "$no_opens" -eq 1 ]]; then
echo "Patches remained open on stale branch (make sure to abandon them):"
echo "https://review.opendev.org/q/status:open+project:${repo}+branch:stable/${SERIES}"
fi
return $no_opens
}
function eom_tag_matches_head {
head=$(git log --oneline --decorate -1)
[[ "$head" =~ "${SERIES}-eom" ]] && [[ "$head" =~ "origin/stable/${SERIES}" ]]
matches=$?
if [[ "$matches" -eq 1 ]] ; then
tags=$(git tag)
[[ "$tags" =~ "${SERIES}-eom" ]]
eom_tag_exists=$?
if [[ "$eom_tag_exists" -eq 0 ]]; then
echo "WARNING !!! stable/${SERIES} has patches on top of the ${SERIES}-eom tag."
echo "Please check the branch and ${SERIES}-eom tag manually."
echo "Do not delete the branch if you are not sure!"
read -p "> If you are sure the branch can be deleted, then press D + Enter: " DELETE
if [ "${DELETE,,}" == "d" ]; then
matches=0
else
echo "Skipping."
fi
else
echo "No ${SERIES}-eom tag found! Branch cannot be deleted. Skipping."
fi
fi
return $matches
}
function is_eom {
${TOOLSDIR}/delete_stable_branch.py check --quiet ${repo} ${SERIES}
if [[ $? -eq 0 ]]; then
echo
echo "${repo} contains eom stale branch (${SERIES})"
clone_repo ${repo} stable/${SERIES}
cd ${repo}
if no_open_patches && eom_tag_matches_head; then
read -p "> Do you want to delete the branch stable/${SERIES} from ${repo} repository? [y/N]: " YN
if [ "${YN,,}" == "y" ]; then
if [ -z "$gerrit_username" ]; then
read -p "Gerrit username: " gerrit_username
fi
${TOOLSDIR}/delete_stable_branch.py delete ${gerrit_username} ${repo} ${SERIES}
fi
fi
cd ..
fi
}
repos=$(list-deliverables -r --series "${SERIES}" --is-eom)
# Show the eom stale branches for each repository.
for repo in ${repos}; do
cd ${MYTMPDIR}
echo
echo " --- $repo ($SERIES) --- "
is_eom "${repo}" "${SERIES}"
done