chore: Adds release notes to minor versions release notes (#583)

Author: oarbusi

tools/releaser/scripts/breaking-changes.sh

@@ -37,26 +37,48 @@ RAW_CHANGES=$(gorelease -base "$BASE_VERSION")
 echo "Changes detected from BASE_VERSION $BASE_VERSION:"
 echo "$RAW_CHANGES"
 
-BREAKING_CHANGES=$(echo "$RAW_CHANGES" | awk '
-    /## incompatible changes/ {print "### incompatible changes"; collecting=1; next}
-    collecting && /^#/ {collecting=0}
-    collecting && NF {print "- "$0}
-')
+# Function to extract changes by section
+extract_changes() {
+    local section=$1
+    echo "$RAW_CHANGES" | awk -v section="$section" '
+        $0 ~ section {print "### " section; collecting=1; next}
+        collecting && /^#/ {collecting=0}
+        collecting && NF {print "- "$0}
+    '
+}
+
+# Extract different types of changes
+BREAKING_CHANGES=$(extract_changes "incompatible changes")
+NEW_FEATURES=$(extract_changes "new features")
+BUG_FIXES=$(extract_changes "bug fixes")
+DEPRECATIONS=$(extract_changes "deprecations")
+OTHER_CHANGES=$(extract_changes "other changes")
+
+# Combine non-breaking changes for release notes
+NON_BREAKING_CHANGES=""
+[ -n "$NEW_FEATURES" ] && NON_BREAKING_CHANGES+="\n## New Features\n$NEW_FEATURES"
+[ -n "$BUG_FIXES" ] && NON_BREAKING_CHANGES+="\n## Bug Fixes\n$BUG_FIXES"
+[ -n "$DEPRECATIONS" ] && NON_BREAKING_CHANGES+="\n## Deprecations\n$DEPRECATIONS"
+[ -n "$OTHER_CHANGES" ] && NON_BREAKING_CHANGES+="\n## Other Changes\n$OTHER_CHANGES"
 
 set -e
 popd || exit
 
-if [ -z "$BREAKING_CHANGES" ]; then
-  echo "No major breaking changes detected"
+if [ -z "$BREAKING_CHANGES" ] && [ -z "$NON_BREAKING_CHANGES" ]; then
+  echo "No changes detected"
 else
-  echo "Detected major breaking changes in the release"
+  echo "Detected changes in the release"
   if [ -z "$TARGET_BREAKING_CHANGES_FILE" ]; then
-    echo "Breaking changes for the major release"
-    echo "$BREAKING_CHANGES"
+    echo "Changes for the release:"
+    [ -n "$BREAKING_CHANGES" ] && echo -e "\nBreaking Changes:\n$BREAKING_CHANGES"
+    [ -n "$NON_BREAKING_CHANGES" ] && echo -e "\nNon-Breaking Changes:$NON_BREAKING_CHANGES"
   else
-    echo "Creating the breaking changes file with following breaking changes:"
-    echo "$BREAKING_CHANGES"
-    echo -e "# Breaking Changes\n## SDK changes\n$BREAKING_CHANGES\n## API Changelog\n https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog" \
-      >"$script_path/../breaking_changes/${TARGET_BREAKING_CHANGES_FILE}.md"
+    # Only create breaking changes file for major version bumps
+    if [ -n "$BREAKING_CHANGES" ]; then
+      echo "Creating the breaking changes file with following breaking changes:"
+      echo "$BREAKING_CHANGES"
+      echo -e "# Breaking Changes\n## SDK changes\n$BREAKING_CHANGES\n## API Changelog\n https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog" \
+        >"$script_path/../breaking_changes/${TARGET_BREAKING_CHANGES_FILE}.md"
+    fi
   fi
 fi

tools/releaser/scripts/extract-version.sh

@@ -9,6 +9,7 @@ SDK_VERSION=$(grep -o 'Version = "[^"]*"' "$file_path" | awk -F'"' '{print $2}')
 SDK_RESOURCE_VERSION=$(grep -o 'Resource = "[^"]*"' "$file_path" | awk -F'"' '{print $2}')
 
 # Extract the minor and major parts of the version
+SDK_PATCH_VERSION=$(echo "$SDK_VERSION" | awk -F'.' '{print $3}')
 SDK_MINOR_VERSION=$(echo "$SDK_VERSION" | awk -F'.' '{print $2}')
 SDK_MAJOR_VERSION=$(echo "$SDK_VERSION" | awk -F'.' '{print $1}')
 
@@ -17,7 +18,7 @@ HYPEN_RESOURCE_VERSION=$(cat $versions_file_path | jq -r ' .[-1]')
 NEW_RESOURCE_VERSION=$(echo "$HYPEN_RESOURCE_VERSION" | tr -d '-')
 
 echo "Extracted version from version.go file: '$SDK_VERSION'. Resource Version: '$SDK_RESOURCE_VERSION'"
-echo "Major: $SDK_MAJOR_VERSION' Minor: $SDK_MINOR_VERSION"
+echo "Major: $SDK_MAJOR_VERSION' Minor: $SDK_MINOR_VERSION Patch: $SDK_PATCH_VERSION"
 echo "Extracted version versions.json: '$NEW_RESOURCE_VERSION'."
 
 

tools/releaser/scripts/setghenv.sh

@@ -22,13 +22,23 @@ export HYPEN_RESOURCE_VERSION="${HYPEN_RESOURCE_VERSION}"
 EOF=$(dd if=/dev/urandom bs=15 count=1 status=none | base64)
 
 RELEASE_NOTES=$(envsubst < "$script_path/../templates/RELEASE_NOTES.tmpl")
-breaking_changes_path="$script_path/../breaking_changes/${SDK_MAJOR_VERSION}.md"
-if [ -f "$breaking_changes_path" ]; then
-   echo "Found breaking changes file for $SDK_MAJOR_VERSION"
-   BREAKING_CHANGES=$(cat "$breaking_changes_path")
-   RELEASE_NOTES=$(echo -e "${RELEASE_NOTES}\n\n${BREAKING_CHANGES}")
-fi
 
+# Check if this is a major version bump (when MINOR is 0)
+if [ "$SDK_MINOR_VERSION" = "0" ] && [ "$SDK_PATCH_VERSION" = "0" ]; then
+    # For major versions, include breaking changes from the file
+    breaking_changes_path="$script_path/../breaking_changes/${SDK_MAJOR_VERSION}.md"
+    if [ -f "$breaking_changes_path" ]; then
+        echo "Found breaking changes file for $SDK_MAJOR_VERSION"
+        BREAKING_CHANGES=$(cat "$breaking_changes_path")
+        RELEASE_NOTES=$(echo -e "${RELEASE_NOTES}\n\n${BREAKING_CHANGES}")
+    fi
+else
+    # For minor versions, include non-breaking changes directly
+    if [ -n "$NON_BREAKING_CHANGES" ]; then
+        echo "Adding non-breaking changes to release notes"
+        RELEASE_NOTES=$(echo -e "${RELEASE_NOTES}\n\n## Changes\n${NON_BREAKING_CHANGES}")
+    fi
+fi
 
 ## Multiline string
 {