Files
coder/scripts/update-release-calendar.sh

248 lines
7.0 KiB
Bash
Executable File

#!/bin/bash
set -euo pipefail
# This script automatically updates the release calendar in docs/install/releases/index.md
# It calculates the releases based on the first Tuesday of each month rule
# and updates the status of each release (Not Supported, Security Support, Stable, Mainline, Not Released)
DOCS_FILE="docs/install/releases/index.md"
CALENDAR_START_MARKER="<!-- RELEASE_CALENDAR_START -->"
CALENDAR_END_MARKER="<!-- RELEASE_CALENDAR_END -->"
current_date=$(date +"%Y-%m-%d")
current_month=$(date +"%m")
current_year=$(date +"%Y")
get_first_tuesday() {
local year=$1
local month=$2
local first_day
local days_until_tuesday
local first_tuesday
first_day=$(date -d "$year-$month-01" +"%u")
days_until_tuesday=$((first_day == 2 ? 0 : (9 - first_day) % 7))
first_tuesday=$(date -d "$year-$month-01 +$days_until_tuesday days" +"%Y-%m-%d")
echo "$first_tuesday"
}
# Format date as "Month DD, YYYY"
format_date() {
date -d "$1" +"%B %d, %Y"
}
get_latest_patch() {
local version_major=$1
local version_minor=$2
local tags
local latest
# Get all tags for this minor version
tags=$(cd "$(git rev-parse --show-toplevel)" && git tag | grep "^v$version_major\\.$version_minor\\." | sort -V)
latest=$(echo "$tags" | tail -1)
if [ -z "$latest" ]; then
echo ""
else
echo "${latest#v}"
fi
}
get_next_release_month() {
local current_month=$1
local next_month=$((current_month + 1))
# Handle December -> February transition (skip January)
if [[ $next_month -eq 13 ]]; then
next_month=2 # Skip to February
return $next_month
fi
# Skip January for all years starting 2025
if [[ $next_month -eq 1 ]]; then
next_month=2
fi
return $next_month
}
# Generate releases table showing:
# - 3 previous unsupported releases
# - 1 security support release (n-2)
# - 1 stable release (n-1)
# - 1 mainline release (n)
# - 1 next release (n+1)
generate_release_calendar() {
local result=""
local version_major=2
local latest_version
local version_minor
local start_minor
# Find the current minor version by looking at the last mainline release tag
latest_version=$(cd "$(git rev-parse --show-toplevel)" && git tag | grep '^v[0-9]*\.[0-9]*\.[0-9]*$' | sort -V | tail -1)
version_minor=$(echo "$latest_version" | cut -d. -f2)
# Start with 3 unsupported releases back
start_minor=$((version_minor - 5))
result="| Release name | Release Date | Status | Latest Release |\n"
result+="|--------------|--------------|--------|----------------|\n"
# Find the latest release month and year
local current_release_minor=$((version_minor - 1)) # Current stable release
local tag_date
tag_date=$(cd "$(git rev-parse --show-toplevel)" && git log -1 --format=%ai "v$version_major.$current_release_minor.0" 2>/dev/null || echo "")
local current_release_month
local current_release_year
if [ -n "$tag_date" ]; then
# Extract month and year from tag date
current_release_month=$(date -d "$tag_date" +"%m")
current_release_year=$(date -d "$tag_date" +"%Y")
else
# Default to current month/year if tag not found
current_release_month=$current_month
current_release_year=$current_year
fi
# Generate rows for each release (7 total: 3 unsupported, 1 security, 1 stable, 1 mainline, 1 next)
for i in {0..6}; do
# Calculate release minor version
local rel_minor=$((start_minor + i))
local version_name="$version_major.$rel_minor"
local release_date
local formatted_date
local latest_patch
local patch_link
local status
local formatted_version_name
# Calculate the release month and year based on the current release's date
# For previous releases, go backward in the release_months array
# For future releases, go forward
local month_offset=$((i - 4)) # 4 is the index of the stable release (i=4)
# Start from the current stable release month
local rel_month=$current_release_month
local rel_year=$current_release_year
# Apply the offset to get the target release month
if [ $month_offset -lt 0 ]; then
# For previous releases, go backward
for ((j = 0; j > month_offset; j--)); do
rel_month=$((rel_month - 1))
if [ $rel_month -eq 0 ]; then
rel_month=12
rel_year=$((rel_year - 1))
elif [ $rel_month -eq 1 ]; then
# Skip January (go from February to December of previous year)
rel_month=12
rel_year=$((rel_year - 1))
fi
done
elif [ $month_offset -gt 0 ]; then
# For future releases, go forward
for ((j = 0; j < month_offset; j++)); do
rel_month=$((rel_month + 1))
if [ $rel_month -eq 13 ]; then
rel_month=2 # Skip from December to February
rel_year=$((rel_year + 1))
elif [ $rel_month -eq 1 ]; then
# Skip January
rel_month=2
fi
done
fi
# Get release date (first Tuesday of the month)
release_date=$(get_first_tuesday "$rel_year" "$(printf "%02d" "$rel_month")")
formatted_date=$(format_date "$release_date")
# Get latest patch version
latest_patch=$(get_latest_patch "$version_major" "$rel_minor")
if [ -n "$latest_patch" ]; then
patch_link="[v${latest_patch}](https://github.com/coder/coder/releases/tag/v${latest_patch})"
else
patch_link="N/A"
fi
# Determine status
if [[ "$release_date" > "$current_date" ]]; then
status="Not Released"
elif [[ $i -eq 6 ]]; then
status="Not Released"
elif [[ $i -eq 5 ]]; then
status="Mainline"
elif [[ $i -eq 4 ]]; then
status="Stable"
elif [[ $i -eq 3 ]]; then
status="Security Support"
else
status="Not Supported"
fi
# Format version name and patch link based on release status
if [[ "$status" == "Not Released" ]]; then
formatted_version_name="$version_name"
patch_link="N/A"
else
formatted_version_name="[$version_name](https://coder.com/changelog/coder-$version_major-$rel_minor)"
fi
# Add row to table
result+="| $formatted_version_name | $formatted_date | $status | $patch_link |\n"
done
echo -e "$result"
}
# Check if the markdown comments exist in the file
if ! grep -q "$CALENDAR_START_MARKER" "$DOCS_FILE" || ! grep -q "$CALENDAR_END_MARKER" "$DOCS_FILE"; then
echo "Error: Markdown comment anchors not found in $DOCS_FILE"
echo "Please add the following anchors around the release calendar table:"
echo " $CALENDAR_START_MARKER"
echo " $CALENDAR_END_MARKER"
exit 1
fi
# Generate the new calendar table content
NEW_CALENDAR=$(generate_release_calendar)
# Update the file while preserving the rest of the content
awk -v start_marker="$CALENDAR_START_MARKER" \
-v end_marker="$CALENDAR_END_MARKER" \
-v new_calendar="$NEW_CALENDAR" \
'
BEGIN { found_start = 0; found_end = 0; print_line = 1; }
$0 ~ start_marker {
print;
print new_calendar;
found_start = 1;
print_line = 0;
next;
}
$0 ~ end_marker {
found_end = 1;
print_line = 1;
print;
next;
}
print_line || !found_start || found_end { print }
' "$DOCS_FILE" >"${DOCS_FILE}.new"
# Replace the original file with the updated version
mv "${DOCS_FILE}.new" "$DOCS_FILE"
# run make fmt/markdown
make fmt/markdown
echo "Successfully updated release calendar in $DOCS_FILE"