chore: Add more categories and titles for release notes (#5632)

mafredri · deansheather · web-flow · commit aec15905b57a · 2023-01-09T21:19:07.000+02:00
Co-authored-by: Dean Sheather &lt;dean@deansheather.com&gt;
diff --git a/scripts/release/check_commit_metadata.sh b/scripts/release/check_commit_metadata.sh
@@ -106,7 +106,8 @@ main() {
 			commit_prefix=${BASH_REMATCH[1]}
 		fi
 		case $commit_prefix in
-		feat | fix)
+		# From: https://github.com/commitizen/conventional-commit-types
+		feat | fix | docs | style | refactor | perf | test | build | ci | chore | revert)
 			COMMIT_METADATA_CATEGORY[$commit_sha_short]=$commit_prefix
 			;;
 		*)
diff --git a/scripts/release/generate_release_notes.sh b/scripts/release/generate_release_notes.sh
@@ -64,58 +64,83 @@ source "$SCRIPT_DIR/release/check_commit_metadata.sh" "${old_version}" "${ref}"
 # Sort commits by title prefix, then by date, only return sha at the end.
 mapfile -t commits < <(git log --no-merges --pretty=format:"%ct %h %s" "${old_version}..${ref}" | sort -k3,3 -k1,1n | cut -d' ' -f2)
 
-breaking_changelog=
-feat_changelog=
-fix_changelog=
-other_changelog=
+# From: https://github.com/commitizen/conventional-commit-types
+# NOTE(mafredri): These need to be supported in check_commit_metadata.sh as well.
+declare -a section_order=(
+	breaking
+	feat
+	fix
+	docs
+	refactor
+	perf
+	test
+	build
+	ci
+	chore
+	revert
+	other
+)
+
+declare -A section_titles=(
+	[breaking]='BREAKING CHANGES'
+	[feat]='Features'
+	[fix]='Bug Fixes'
+	[docs]='Documentation'
+	[refactor]='Code Refactoring'
+	[perf]='Performance Improvements'
+	[test]='Tests'
+	[build]='Builds'
+	[ci]='Continuous Integration'
+	[chore]='Chores'
+	[revert]='Reverts'
+	[other]='Other Changes'
+)
+
+# Verify that all items in section_order exist as keys in section_titles and
+# vice-versa.
+for cat in "${section_order[@]}"; do
+	if [[ " ${!section_titles[*]} " != *" $cat "* ]]; then
+		error "BUG: category $cat does not exist in section_titles"
+	fi
+done
+for cat in "${!section_titles[@]}"; do
+	if [[ " ${section_order[*]} " != *" $cat "* ]]; then
+		error "BUG: Category $cat does not exist in section_order"
+	fi
+done
 
 for commit in "${commits[@]}"; do
 	line="- $commit ${COMMIT_METADATA_TITLE[$commit]}\n"
 
-	case "${COMMIT_METADATA_CATEGORY[$commit]}" in
-	breaking)
-		breaking_changelog+="$line"
-		;;
-	feat)
-		feat_changelog+="$line"
-		;;
-	fix)
-		fix_changelog+="$line"
-		;;
-	*)
-		other_changelog+="$line"
-		;;
-	esac
+	# Default to "other" category.
+	cat=other
+	for c in "${!section_titles[@]}"; do
+		if [[ $c == "${COMMIT_METADATA_CATEGORY[$commit]}" ]]; then
+			cat=$c
+			break
+		fi
+	done
+	declare "$cat"_changelog+="$line"
 done
 
 changelog="$(
-	if ((${#breaking_changelog} > 0)); then
-		echo -e "### BREAKING CHANGES\n"
-		echo -e "$breaking_changelog"
-	fi
-	if ((${#feat_changelog} > 0)); then
-		echo -e "### Features\n"
-		echo -e "$feat_changelog"
-	fi
-	if ((${#fix_changelog} > 0)); then
-		echo -e "### Bug fixes\n"
-		echo -e "$fix_changelog"
-	fi
-	if ((${#other_changelog} > 0)); then
-		echo -e "### Other changes\n"
-		echo -e "$other_changelog"
-	fi
+	for cat in "${section_order[@]}"; do
+		changes="$(eval "echo -e \"\${${cat}_changelog:-}\"")"
+		if ((${#changes} > 0)); then
+			echo -e "\n### ${section_titles["$cat"]}\n"
+			echo -e "$changes"
+		fi
+	done
 )"
 
 image_tag="$(execrelative ./image_tag.sh --version "$new_version")"
 
 echo -e "## Changelog
-
 $changelog
 
 Compare: [\`${old_version}...${new_version}\`](https://github.com/coder/coder/compare/${old_version}...${new_version})
 
-## Container image
+## Container Image
 
 - \`docker pull $image_tag\`
 "
