Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix(ci): generate-release-notes should account for features, fixes, etc. in merge commits and bullet-style format:\ Summary The issue was that the generate-release-notes.sh script was only looking at commit subject lines using git log --format="%h %s", but merge commits often contain the actual feature and fix information in their commit body with 

bullet point formatting like:

  * feat: some feature  * fix: some fix    Changes made:    1. Added new function get_commits_with_body() that uses git log                           --format="%B" to get full commit messages  2. Updated pattern matching to handle both direct commits and bullet-pointed   entries in merge commits (supporting both * and - bullets)  3. Modified the feature and fix extraction to check both commit subjects and   commit bodies  4. Fixed pattern anchoring by removing ^ anchors when calling the body  parsing function
pull/6190/head
Jason Stirnaman 2025-07-05 22:27:44 -05:00
parent 3f74294584
commit c60483a784
1 changed files with 27 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
helper-scripts/common/generate-release-notes.sh
View File

@ -121,6 +121,21 @@ get_commits_from_repo() {
fi
}
# Function to get commits including merge commit bodies
get_commits_with_body() {
local repo_path="$1"
local pattern="$2"
if [ -d "$repo_path" ]; then
# Get full commit messages and extract lines matching the pattern
# Handle both direct commit format and bullet point format in merge commits (*, -)
git -C "$repo_path" log --format="%B" "${FROM_VERSION}..${TO_VERSION}" 2>/dev/null | \
grep -E "(^${pattern}|^\* ${pattern}|^- ${pattern})" | \
sed 's/^[[:space:]]*[\*-] //' | \
sed 's/^[[:space:]]*//' || true
fi
}
# Function to analyze API-related commits
analyze_api_changes() {
local repo_path="$1"
@ -222,14 +237,18 @@ for repo in "${ALL_REPOS[@]}"; do
repo_name=$(basename "$repo")
echo -e " Analyzing $repo_name..."
# Features
repo_features=$(get_commits_from_repo "$repo" "^[a-f0-9]+ feat:" | sed "s/^[a-f0-9]* feat: /- [$repo_name] /")
# Features - check both commit subjects and merge commit bodies
repo_features_subject=$(get_commits_from_repo "$repo" "^[a-f0-9]+ feat:" | sed "s/^[a-f0-9]* feat: /- [$repo_name] /")
repo_features_body=$(get_commits_with_body "$repo" "feat:" | sed "s/^feat: /- [$repo_name] /")
repo_features=$(printf "%s\n%s" "$repo_features_subject" "$repo_features_body" | grep -v "^$" || true)
if [ -n "$repo_features" ]; then
FEATURES="$FEATURES$repo_features"$'\n'
fi
# Fixes
repo_fixes=$(get_commits_from_repo "$repo" "^[a-f0-9]+ fix:" | sed "s/^[a-f0-9]* fix: /- [$repo_name] /")
# Fixes - check both commit subjects and merge commit bodies
repo_fixes_subject=$(get_commits_from_repo "$repo" "^[a-f0-9]+ fix:" | sed "s/^[a-f0-9]* fix: /- [$repo_name] /")
repo_fixes_body=$(get_commits_with_body "$repo" "fix:" | sed "s/^fix: /- [$repo_name] /")
repo_fixes=$(printf "%s\n%s" "$repo_fixes_subject" "$repo_fixes_body" | grep -v "^$" || true)
if [ -n "$repo_fixes" ]; then
FIXES="$FIXES$repo_fixes"$'\n'
fi
@ -240,8 +259,10 @@ for repo in "${ALL_REPOS[@]}"; do
BREAKING="$BREAKING$repo_breaking"$'\n'
fi
# Performance improvements
repo_perf=$(get_commits_from_repo "$repo" "^[a-f0-9]+ perf:" | sed "s/^[a-f0-9]* perf: /- [$repo_name] /")
# Performance improvements - check both commit subjects and merge commit bodies
repo_perf_subject=$(get_commits_from_repo "$repo" "^[a-f0-9]+ perf:" | sed "s/^[a-f0-9]* perf: /- [$repo_name] /")
repo_perf_body=$(get_commits_with_body "$repo" "perf:" | sed "s/^perf: /- [$repo_name] /")
repo_perf=$(printf "%s\n%s" "$repo_perf_subject" "$repo_perf_body" | grep -v "^$" || true)
if [ -n "$repo_perf" ]; then
PERF="$PERF$repo_perf"$'\n'
fi