fix(presets): now changelogs are sorted and works properly

dalisoft · Apr 27, 2024 · 95674a0 · 95674a0
1 parent a22a323
commit 95674a0
Show file tree

Hide file tree

Showing 2 changed files with 75 additions and 34 deletions.
diff --git a/presets/conventional-commits.sh b/presets/conventional-commits.sh
@@ -7,17 +7,19 @@ regexp_commit_major="^([a-z]+)(\(([^\)]+)\))?!?:\ (.+)$"
 string_commit_major="^BREAKING CHANGE(: )?(.+)"
 
 # Release types
-# shellcheck disable=2034
-RELEASE_SKIP_TYPES=("build" "chore" "docs" "test" "style" "ci" "skip ci")
-# shellcheck disable=2034
+RELEASE_SKIP_TYPES=("build" "chore" "style" "ci" "skip ci")
 RELEASE_PATCH_TYPES=("fix" "close" "closes" "perf" "revert")
-# shellcheck disable=2034
 RELEASE_MINOR_TYPES=("refactor" "feat")
-# shellcheck disable=2034
 RELEASE_MAJOR_TYPES=("BREAKING CHANGE")
 
+UNAFFECTED_TYPES=("test" "docs")
 INCLUDE_SCOPE=("refactor" "perf" "revert")
 
+CHANGELOG_STORE_UNCHANGED=("")
+CHANGELOG_STORE_PATCH=("")
+CHANGELOG_STORE_MINOR=("")
+CHANGELOG_STORE_MAJOR=("")
+
 # This function parses a single commit message
 parse_commit() {
   local -n COMMIT_MSG="$1"
@@ -51,36 +53,53 @@ parse_commit() {
     description="$subject"
   fi
 
+  local line=""
+  line+="- "
+  if is_valid_commit_type "$type" "${INCLUDE_SCOPE[@]}"; then
+    line+="**\`[$type]\`** "
+  fi
+
+  if [ -n "${scope-}" ]; then
+    line+="**$scope**: "
+  fi
+  line+="$description "
+  line+="([\`$hash\`](https://github.com/$GIT_REPO_NAME/commit/$sha256))"
+
   # Handle other type of commits
   if is_valid_commit_type "$type" "${RELEASE_SKIP_TYPES[@]}"; then
     return 0
   elif is_valid_commit_type "$type" "${RELEASE_PATCH_TYPES[@]}"; then
     if ! $PATCH_UPGRADED; then
       PATCH_UPGRADED=true
-      RELEASE_BODY+="\n## Bug Fixes\n\n"
     fi
+    CHANGELOG_STORE_PATCH+=("$line")
   elif is_valid_commit_type "$type" "${RELEASE_MINOR_TYPES[@]}"; then
     if ! $MINOR_UPGRADED; then
       MINOR_UPGRADED=true
-      RELEASE_BODY+="\n## Features\n\n"
     fi
+    CHANGELOG_STORE_MINOR+=("$line")
   elif is_valid_commit_type "$type" "${RELEASE_MAJOR_TYPES[@]}"; then
     if ! $MAJOR_UPGRADED; then
       MAJOR_UPGRADED=true
-      RELEASE_BODY+="\n## BREAKING CHANGES\n\n"
     fi
-  else
-    return 0
+    CHANGELOG_STORE_MAJOR+=("$line")
+  elif is_valid_commit_type "$type" "${UNAFFECTED_TYPES[@]}"; then
+    CHANGELOG_STORE_UNCHANGED+=("$line")
   fi
+}
 
-  RELEASE_BODY+="- "
-  if is_valid_commit_type "$type" "${INCLUDE_SCOPE[@]}"; then
-    RELEASE_BODY+="**\`[$type]\`** "
-  fi
+build_release() {
+  local IFS=$'\n'
 
-  if [ -n "${scope-}" ]; then
-    RELEASE_BODY+="**$scope**: "
-  fi
-  RELEASE_BODY+="$description "
-  RELEASE_BODY+="([\`$hash\`](https://github.com/$GIT_REPO_NAME/commit/$sha256))\n"
+  RELEASE_BODY+="\n## BREAKING CHANGES\n"
+  RELEASE_BODY+="${CHANGELOG_STORE_MAJOR[*]}"
+
+  RELEASE_BODY+="\n\n## Features\n"
+  RELEASE_BODY+="${CHANGELOG_STORE_MINOR[*]}"
+
+  RELEASE_BODY+="\n\n## Bug Fixes\n"
+  RELEASE_BODY+="${CHANGELOG_STORE_PATCH[*]}"
+
+  RELEASE_BODY+="\n\n## Other improvements\n"
+  RELEASE_BODY+="${CHANGELOG_STORE_UNCHANGED[*]}"
 }
diff --git a/presets/workspace.sh b/presets/workspace.sh
@@ -4,20 +4,22 @@ set -eu
 # RegExp as variable
 regexp_commit_primary="^([a-z]+)(\(([^\)]+)\))?:\ (.+)$"
 regexp_commit_major="^([a-z]+)(\(([^\)]+)\))?!?:\ (.+)$"
-string_commit_major="^BREAKING CHANGE"
+string_commit_major="^BREAKING CHANGE(: )?(.+)"
 
 # Release types
-# shellcheck disable=2034
-RELEASE_SKIP_TYPES=("build" "chore" "docs" "test" "style" "ci" "skip ci")
-# shellcheck disable=2034
+RELEASE_SKIP_TYPES=("build" "chore" "style" "ci" "skip ci")
 RELEASE_PATCH_TYPES=("fix" "close" "closes" "perf" "revert")
-# shellcheck disable=2034
 RELEASE_MINOR_TYPES=("refactor" "feat")
-# shellcheck disable=2034
 RELEASE_MAJOR_TYPES=("BREAKING CHANGE")
 
+UNAFFECTED_TYPES=("test" "docs")
 INCLUDE_SCOPE=("refactor" "perf" "revert")
 
+CHANGELOG_STORE_UNCHANGED=("")
+CHANGELOG_STORE_PATCH=("")
+CHANGELOG_STORE_MINOR=("")
+CHANGELOG_STORE_MAJOR=("")
+
 # This function parses a single commit message
 parse_commit() {
   local -n COMMIT_MSG="$1"
@@ -36,6 +38,7 @@ parse_commit() {
     type="${BASH_REMATCH[1]}"
     scope="${BASH_REMATCH[3]}"
     description="${BASH_REMATCH[4]}"
+
   elif [[ "$subject" =~ $regexp_commit_major ]]; then
     type="BREAKING CHANGE"
     scope="${BASH_REMATCH[3]}"
@@ -55,30 +58,49 @@ parse_commit() {
     description="$subject"
   fi
 
+  local line=""
+  if is_valid_commit_type "$type" "${INCLUDE_SCOPE[@]}"; then
+    line+="- **$PKG_NAME**: **\`[$type]\`** $description "
+  else
+    line+="- **$PKG_NAME**: $description "
+  fi
+  line+="([\`$hash\`](https://github.com/$GIT_REPO_NAME/commit/$sha256))"
+
   # Handle other type of commits
   if is_valid_commit_type "$type" "${RELEASE_SKIP_TYPES[@]}"; then
     return 0
   elif is_valid_commit_type "$type" "${RELEASE_PATCH_TYPES[@]}"; then
     if ! $PATCH_UPGRADED; then
       PATCH_UPGRADED=true
-      RELEASE_BODY+="\n## Bug Fixes\n\n"
     fi
+    CHANGELOG_STORE_PATCH+=("$line")
   elif is_valid_commit_type "$type" "${RELEASE_MINOR_TYPES[@]}"; then
     if ! $MINOR_UPGRADED; then
       MINOR_UPGRADED=true
-      RELEASE_BODY+="\n## Features\n\n"
     fi
+    CHANGELOG_STORE_MINOR+=("$line")
   elif is_valid_commit_type "$type" "${RELEASE_MAJOR_TYPES[@]}"; then
     if ! $MAJOR_UPGRADED; then
       MAJOR_UPGRADED=true
-      RELEASE_BODY+="\n## BREAKING CHANGES\n\n"
     fi
+    CHANGELOG_STORE_MAJOR+=("$line")
+  elif is_valid_commit_type "$type" "${UNAFFECTED_TYPES[@]}"; then
+    CHANGELOG_STORE_UNCHANGED+=("$line")
   fi
+}
 
-  if is_valid_commit_type "$type" "${INCLUDE_SCOPE[@]}"; then
-    RELEASE_BODY+="- **$PKG_NAME**: **\`[$type]\`** $description "
-  else
-    RELEASE_BODY+="- **$PKG_NAME**: $description "
-  fi
-  RELEASE_BODY+="([\`$hash\`](https://github.com/$GIT_REPO_NAME/commit/$sha256))\n"
+build_release() {
+  local IFS=$'\n'
+
+  RELEASE_BODY+="\n## BREAKING CHANGES\n"
+  RELEASE_BODY+="${CHANGELOG_STORE_MAJOR[*]}"
+
+  RELEASE_BODY+="\n\n## Features\n"
+  RELEASE_BODY+="${CHANGELOG_STORE_MINOR[*]}"
+
+  RELEASE_BODY+="\n\n## Bug Fixes\n"
+  RELEASE_BODY+="${CHANGELOG_STORE_PATCH[*]}"
+
+  RELEASE_BODY+="\n\n## Other improvements\n"
+  RELEASE_BODY+="${CHANGELOG_STORE_UNCHANGED[*]}"
 }