Skip to content

Instantly share code, notes, and snippets.

@coulof
Last active May 3, 2023 12:26
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save coulof/fe25743763a59e080e3f01a4717f5dc9 to your computer and use it in GitHub Desktop.
Save coulof/fe25743763a59e080e3f01a4717f5dc9 to your computer and use it in GitHub Desktop.
Get supported version of CSI Sidecar use it with : python ~/go/src/github.com/kubernetes-csi/csi-release-tools/get_supported_version_csi-sidecar.py -R kubernetes-csi/external-attacher --doc
import argparse
import datetime
import re
from collections import defaultdict
import subprocess
import shutil
from dateutil.relativedelta import relativedelta
# Check that the `gh` command is in the path
def check_gh_command():
if not shutil.which('gh'):
print("Error: The `gh` command is not available in the PATH.")
print("Please install the GitHub CLI (https://cli.github.com/) and try again.")
exit(1)
# humanize duration outputs
def duration_ago(dt):
delta = relativedelta(datetime.datetime.now(), dt)
if delta.years > 0:
return f"{delta.years} year{'s' if delta.years > 1 else ''} ago"
elif delta.months > 0:
return f"{delta.months} month{'s' if delta.months > 1 else ''} ago"
elif delta.days > 0:
return f"{delta.days} day{'s' if delta.days > 1 else ''} ago"
elif delta.hours > 0:
return f"{delta.hours} hour{'s' if delta.hours > 1 else ''} ago"
elif delta.minutes > 0:
return f"{delta.minutes} minute{'s' if delta.minutes > 1 else ''} ago"
else:
return "just now"
def parse_version(version):
# version pattern
pattern = r"v(\d+)\.(\d+)\.(\d+)"
match = re.match(pattern, line)
if match:
major, minor, patch = map(int, match.groups())
return (major, minor, patch)
# Calculate the end of life date for a minor release version
# according to : https://kubernetes-csi.github.io/docs/project-policies.html#support
def end_of_life_grouped_versions(versions):
supported_versions = []
# Prepare dates for later calculation
now = datetime.datetime.now()
one_year = datetime.timedelta(days=365)
three_months = datetime.timedelta(days=90)
# get the newer versions on top
sorted_versions_list = sorted(versions.items(), key=lambda x: x[0], reverse=True)
# structure example :
# [((3, 5), [('v3.5.0', datetime.datetime(2023, 4, 27, 22, 28, 6))]),
# ((3, 4),
# [('v3.4.1', datetime.datetime(2023, 4, 5, 17, 41, 15)),
# ('v3.4.0', datetime.datetime(2022, 12, 27, 23, 43, 41))])]
latest = sorted_versions_list.pop(0)
# the latest version is always supported no matter the release date
supported_versions.append(latest[1][-1])
for v in sorted_versions_list:
first_release = v[1][-1]
last_release = v[1][0]
# if the release is less than a year old we support the latest patch version
if now - first_release[1] < one_year:
supported_versions.append(last_release)
# if the main release is older than a year and has a recent path, this is supported
elif now - last_release[1] < three_months:
supported_versions.append(last_release)
return supported_versions
def get_release_docker_image(repo, version):
output = subprocess.check_output(['gh', 'release', '-R', args.repo, 'view', version], text=True)
match = re.search(r"`docker pull (.*)`", output)
docker_image = match.group(1)
return((version,docker_image))
# Argument parser
parser = argparse.ArgumentParser(description='Get the currently supported versions for a GitHub repository.')
parser.add_argument('--repo', '-R', required=True, help='The name of the repository in the format owner/repo.')
parser.add_argument('--display', '-d', action='store_true', help='Display EOL versions with their dates', default=True)
parser.add_argument('--doc', '-D', action='store_true', help='Helper to https://kubernetes-csi.github.io/docs/ that prints Docker image for each EOL version')
args = parser.parse_args()
# Verify pre-reqs
check_gh_command()
# Run the `gh release` command to get the release list
output = subprocess.check_output(['gh', 'release', '-R', args.repo, 'list'], text=True)
# Parse the output and group by major and minor version numbers
versions = defaultdict(lambda: [])
for line in output.strip().split('\n'):
parts = line.split('\t')
# pprint.pprint(parts)
version = parts[0]
parsed_version = parse_version(version)
if parsed_version is None:
continue
major, minor, patch = parsed_version
published = datetime.datetime.strptime(parts[3], '%Y-%m-%dT%H:%M:%SZ')
versions[(major, minor)].append((version, published))
eol_versions = end_of_life_grouped_versions(versions)
if args.display:
print("Supported versions with release date and age:\n")
for version in eol_versions:
print(f"{version[0]}\t{version[1].strftime('%Y-%m-%d')}\t{duration_ago(version[1])}")
if args.doc:
print("\nSupported Versions with docker images for each end of life version:\n")
for version in eol_versions:
_, image = get_release_docker_image(args.repo, version[0])
print(f"{version[0]}\t{image}")
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment