summaryrefslogtreecommitdiff
path: root/tools/changelog.sh
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2021-11-06 15:47:31 -0600
committerTuowen Zhao <ztuowen@gmail.com>2021-11-06 15:47:31 -0600
commit2a977876c6e85847652f097cc128e4ed5bec147a (patch)
tree4dba20c6aea6ea18723fa9e47b181580767aee37 /tools/changelog.sh
parentfad92c603be0ff36825cc53bf8c485d4b95c7869 (diff)
parentb2f35a7b98455b2bb8c7c3b11db6aa587e1d28bf (diff)
downloadzsh-2a977876c6e85847652f097cc128e4ed5bec147a.tar.gz
zsh-2a977876c6e85847652f097cc128e4ed5bec147a.tar.bz2
zsh-2a977876c6e85847652f097cc128e4ed5bec147a.zip
Merge remote-tracking branch 'origin/master'
Diffstat (limited to 'tools/changelog.sh')
-rwxr-xr-xtools/changelog.sh111
1 files changed, 70 insertions, 41 deletions
diff --git a/tools/changelog.sh b/tools/changelog.sh
index 7329a9526..664f34608 100755
--- a/tools/changelog.sh
+++ b/tools/changelog.sh
@@ -1,5 +1,8 @@
#!/usr/bin/env zsh
+cd "$ZSH"
+setopt extendedglob
+
##############################
# CHANGELOG SCRIPT CONSTANTS #
##############################
@@ -49,10 +52,15 @@ function parse-commit {
# make a breaking change
function commit:type {
- local type="$(sed -E 's/^([a-zA-Z_\-]+)(\(.+\))?!?: .+$/\1/' <<< "$1")"
+ local type
+
+ # Parse commit type from the subject
+ if [[ "$1" =~ '^([a-zA-Z_\-]+)(\(.+\))?!?: .+$' ]]; then
+ type="${match[1]}"
+ fi
# If $type doesn't appear in $TYPES array mark it as 'other'
- if [[ -n "${(k)TYPES[(i)$type]}" ]]; then
+ if [[ -n "$type" && -n "${(k)TYPES[(i)$type]}" ]]; then
echo $type
else
echo other
@@ -63,17 +71,18 @@ function parse-commit {
local scope
# Try to find scope in "type(<scope>):" format
- scope=$(sed -nE 's/^[a-zA-Z_\-]+\((.+)\)!?: .+$/\1/p' <<< "$1")
- if [[ -n "$scope" ]]; then
- echo "$scope"
+ if [[ "$1" =~ '^[a-zA-Z_\-]+\((.+)\)!?: .+$' ]]; then
+ echo "${match[1]}"
return
fi
# If no scope found, try to find it in "<scope>:" format
- # Make sure it's not a type before printing it
- scope=$(sed -nE 's/^([a-zA-Z_\-]+): .+$/\1/p' <<< "$1")
- if [[ -z "${(k)TYPES[(i)$scope]}" ]]; then
- echo "$scope"
+ if [[ "$1" =~ '^([a-zA-Z_\-]+): .+$' ]]; then
+ scope="${match[1]}"
+ # Make sure it's not a type before printing it
+ if [[ -z "${(k)TYPES[(i)$scope]}" ]]; then
+ echo "$scope"
+ fi
fi
}
@@ -81,7 +90,11 @@ function parse-commit {
# Only display the relevant part of the commit, i.e. if it has the format
# type[(scope)!]: subject, where the part between [] is optional, only
# displays subject. If it doesn't match the format, returns the whole string.
- sed -E 's/^[a-zA-Z_\-]+(\(.+\))?!?: (.+)$/\2/' <<< "$1"
+ if [[ "$1" =~ '^[a-zA-Z_\-]+(\(.+\))?!?: (.+)$' ]]; then
+ echo "${match[2]}"
+ else
+ echo "$1"
+ fi
}
# Return subject if the body or subject match the breaking change format
@@ -114,15 +127,8 @@ function parse-commit {
fi
}
- # Ignore commit if it is a merge commit
- if [[ $(command git show -s --format=%p $1 | wc -w) -gt 1 ]]; then
- return
- fi
-
# Parse commit with hash $1
- local hash="$1" subject body warning rhash
- subject="$(command git show -s --format=%s $hash)"
- body="$(command git show -s --format=%b $hash)"
+ local hash="$1" subject="$2" body="$3" warning rhash
# Commits following Conventional Commits (https://www.conventionalcommits.org/)
# have the following format, where parts between [] are optional:
@@ -195,9 +201,9 @@ function display-release {
#* Uses $hash from outer scope
local hash="${1:-$hash}"
case "$output" in
- raw) printf "$hash" ;;
- text) printf "\e[33m$hash\e[0m" ;; # red
- md) printf "[\`$hash\`](https://github.com/ohmyzsh/ohmyzsh/commit/$hash)" ;;
+ raw) printf '%s' "$hash" ;;
+ text) printf '\e[33m%s\e[0m' "$hash" ;; # red
+ md) printf '[`%s`](https://github.com/ohmyzsh/ohmyzsh/commit/%s)' "$hash" ;;
esac
}
@@ -209,16 +215,16 @@ function display-release {
case "$output" in
raw)
case "$level" in
- 1) printf "$header\n$(printf '%.0s=' {1..${#header}})\n\n" ;;
- 2) printf "$header\n$(printf '%.0s-' {1..${#header}})\n\n" ;;
- *) printf "$header:\n\n" ;;
+ 1) printf '%s\n%s\n\n' "$header" "$(printf '%.0s=' {1..${#header}})" ;;
+ 2) printf '%s\n%s\n\n' "$header" "$(printf '%.0s-' {1..${#header}})" ;;
+ *) printf '%s:\n\n' "$header" ;;
esac ;;
text)
case "$level" in
- 1|2) printf "\e[1;4m$header\e[0m\n\n" ;; # bold, underlined
- *) printf "\e[1m$header:\e[0m\n\n" ;; # bold
+ 1|2) printf '\e[1;4m%s\e[0m\n\n' "$header" ;; # bold, underlined
+ *) printf '\e[1m%s:\e[0m\n\n' "$header" ;; # bold
esac ;;
- md) printf "$(printf '%.0s#' {1..${level}}) $header\n\n" ;;
+ md) printf '%s %s\n\n' "$(printf '%.0s#' {1..${level}})" "$header" ;;
esac
}
@@ -244,8 +250,8 @@ function display-release {
# Print [scope]
case "$output" in
- raw|md) printf "[$scope]${padding} " ;;
- text) printf "[\e[38;5;9m$scope\e[0m]${padding} " ;; # red 9
+ raw|md) printf '[%s]%s ' "$scope" "$padding";;
+ text) printf '[\e[38;5;9m%s\e[0m]%s ' "$scope" "$padding";; # red 9
esac
}
@@ -258,7 +264,7 @@ function display-release {
subject="${(U)subject:0:1}${subject:1}"
case "$output" in
- raw) printf "$subject" ;;
+ raw) printf '%s' "$subject" ;;
# In text mode, highlight (#<issue>) and dim text between `backticks`
text) sed -E $'s|#([0-9]+)|\e[32m#\\1\e[0m|g;s|`([^`]+)`|`\e[2m\\1\e[0m`|g' <<< "$subject" ;;
# In markdown mode, link to (#<issue>) issues
@@ -271,8 +277,8 @@ function display-release {
local type="${1:-${TYPES[$type]:-${(C)type}}}"
[[ -z "$type" ]] && return 0
case "$output" in
- raw|md) printf "$type: " ;;
- text) printf "\e[4m$type\e[24m: " ;; # underlined
+ raw|md) printf '%s: ' "$type" ;;
+ text) printf '\e[4m%s\e[24m: ' "$type" ;; # underlined
esac
}
@@ -286,7 +292,7 @@ function display-release {
(( $#breaking != 0 )) || return 0
case "$output" in
- text) fmt:header "\e[31mBREAKING CHANGES" 3 ;;
+ text) printf '\e[31m'; fmt:header "BREAKING CHANGES" 3 ;;
raw) fmt:header "BREAKING CHANGES" 3 ;;
md) fmt:header "BREAKING CHANGES ⚠" 3 ;;
esac
@@ -384,7 +390,8 @@ function main {
# Commit classification arrays
local -A commits subjects scopes breaking reverts
local truncate=0 read_commits=0
- local hash version tag
+ local version tag
+ local hash refs subject body
# Get the first version name:
# 1) try tag-like version, or
@@ -396,17 +403,41 @@ function main {
|| version=$(command git symbolic-ref --quiet --short $until 2>/dev/null) \
|| version=$(command git rev-parse --short $until 2>/dev/null)
- # Get commit list from $until commit until $since commit, or until root
- # commit if $since is unset, in short hash form.
- command git rev-list --abbrev-commit --abbrev=7 ${since:+$since..}$until | while read hash; do
+ # Get commit list from $until commit until $since commit, or until root commit if $since is unset
+ local range=${since:+$since..}$until
+
+ # Git log options
+ # -z: commits are delimited by null bytes
+ # --format: [7-char hash]<field sep>[ref names]<field sep>[subject]<field sep>[body]
+ # --abbrev=7: force commit hashes to be 7 characters long
+ # --no-merges: merge commits are omitted
+ # --first-parent: commits from merged branches are omitted
+ local SEP="0mZmAgIcSeP"
+ local -a raw_commits
+ raw_commits=(${(0)"$(command git log -z \
+ --format="%h${SEP}%D${SEP}%s${SEP}%b" --abbrev=7 \
+ --no-merges --first-parent $range)"})
+
+ local raw_commit
+ local -a raw_fields
+ for raw_commit in $raw_commits; do
# Truncate list on versions with a lot of commits
if [[ -z "$since" ]] && (( ++read_commits > 35 )); then
truncate=1
break
fi
+ # Read the commit fields (@ is needed to keep empty values)
+ eval "raw_fields=(\"\${(@ps:$SEP:)raw_commit}\")"
+ hash="${raw_fields[1]}"
+ refs="${raw_fields[2]}"
+ subject="${raw_fields[3]}"
+ body="${raw_fields[4]}"
+
# If we find a new release (exact tag)
- if tag=$(command git describe --exact-match --tags $hash 2>/dev/null); then
+ if [[ "$refs" = *tag:\ * ]]; then
+ # Parse tag name (needs: setopt extendedglob)
+ tag="${${refs##*tag: }%%,# *}"
# Output previous release
display-release
# Reinitialize commit storage
@@ -420,7 +451,7 @@ function main {
read_commits=1
fi
- parse-commit "$hash"
+ parse-commit "$hash" "$subject" "$body"
done
display-release
@@ -431,8 +462,6 @@ function main {
fi
}
-cd "$ZSH"
-
# Use raw output if stdout is not a tty
if [[ ! -t 1 && -z "$3" ]]; then
main "$1" "$2" --raw