simple changelog script

This commit is contained in:
Alexander Kuzmenkov 2020-04-14 14:28:27 +03:00
parent a7bf6ad667
commit 48ba1f4ced
2 changed files with 28 additions and 5 deletions

View File

@ -3,8 +3,9 @@ set -e
from="$1" from="$1"
to="$2" to="$2"
log_command=(git log "$from..$to" --first-parent)
git log "$from..$to" --first-parent > "changelog-log.txt" "${log_command[@]}" > "changelog-log.txt"
# NOTE keep in sync with ./backport.sh. # NOTE keep in sync with ./backport.sh.
# Search for PR numbers in commit messages. First variant is normal merge, and second # Search for PR numbers in commit messages. First variant is normal merge, and second
@ -14,11 +15,18 @@ find_prs=(sed -n "s/^.*Merge pull request #\([[:digit:]]\+\).*$/\1/p;
s/^.*back[- ]*port[ed of]*#\([[:digit:]]\+\).*$/\1/Ip; s/^.*back[- ]*port[ed of]*#\([[:digit:]]\+\).*$/\1/Ip;
s/^.*cherry[- ]*pick[ed of]*#\([[:digit:]]\+\).*$/\1/Ip") s/^.*cherry[- ]*pick[ed of]*#\([[:digit:]]\+\).*$/\1/Ip")
"${find_prs[@]}" "changelog-log.txt" | sort -rn > "changelog-prs.txt" "${find_prs[@]}" "changelog-log.txt" | sort -rn | uniq > "changelog-prs.txt"
echo "$(wc -l < "changelog-prs.txt") PRs added between $from and $to." echo "$(wc -l < "changelog-prs.txt") PRs added between $from and $to."
if "${log_command[@]}" --oneline --grep "Merge branch '" | grep ''
then
# DO NOT ADD automated handling of diamond merges to this script.
# It is an unsustainable way to work with git, and it MUST be visible.
echo Warning: suspected diamond merges above.
echo Some commits will be missed, review these manually.
fi
function github_download() function github_download()
{ {
local url=${1} local url=${1}
@ -39,6 +47,7 @@ function github_download()
fi fi
} }
rm changelog-prs-filtered.txt &> /dev/null ||:
for pr in $(cat "changelog-prs.txt") for pr in $(cat "changelog-prs.txt")
do do
# Download PR info from github. # Download PR info from github.
@ -51,6 +60,13 @@ do
continue continue
fi fi
# Filter out PRs by bots.
user_login=$(jq -r .user.login "$file")
if echo "$user_login" | grep "\[bot\]$" > /dev/null
then
continue
fi
# Download author info from github. # Download author info from github.
user_id=$(jq -r .user.id "$file") user_id=$(jq -r .user.id "$file")
user_file="user$user_id.json" user_file="user$user_id.json"
@ -61,9 +77,11 @@ do
>&2 echo "Got wrong data for user #$user_id (please check and remove '$user_file')." >&2 echo "Got wrong data for user #$user_id (please check and remove '$user_file')."
continue continue
fi fi
echo "$pr" >> changelog-prs-filtered.txt
done done
echo "### ClickHouse release $to FIXME as compared to $from echo "### ClickHouse release $to FIXME as compared to $from
" > changelog.md " > changelog.md
./format-changelog.py changelog-prs.txt >> changelog.md ./format-changelog.py changelog-prs-filtered.txt >> changelog.md
cat changelog.md cat changelog.md

View File

@ -30,6 +30,11 @@ def parse_one_pull_request(item):
i += 1 i += 1
if i >= len(lines): if i >= len(lines):
break break
# Can have one empty line between header and the category itself. Filter it out.
if not lines[i]:
i += 1
if i >= len(lines):
break
category = re.sub(r'^[-*\s]*', '', lines[i]) category = re.sub(r'^[-*\s]*', '', lines[i])
i += 1 i += 1
elif re.match(r'(?i)^\**\s*(Short description|Change\s*log entry)', lines[i]): elif re.match(r'(?i)^\**\s*(Short description|Change\s*log entry)', lines[i]):
@ -91,7 +96,7 @@ def print_category(category):
user_name = user["name"] if user["name"] else user["login"] user_name = user["name"] if user["name"] else user["login"]
# Substitute issue links # Substitute issue links
pr["entry"] = re.sub(r'#([0-9]{4,})', r'[#\1](https://github.com/ClickHouse/ClickHouse/issues/\1)', pr["entry"]) pr["entry"] = re.sub(r'([^[])#([0-9]{4,})', r'\1[#\2](https://github.com/ClickHouse/ClickHouse/issues/\2)', pr["entry"])
print(f'* {pr["entry"]} [#{pr["number"]}]({pr["html_url"]}) ([{user_name}]({user["html_url"]})).') print(f'* {pr["entry"]} [#{pr["number"]}]({pr["html_url"]}) ([{user_name}]({user["html_url"]})).')