CLOUDP-204045: Fully automatic release procedure (#214)

Co-authored-by: Matt Condon <[email protected]>

Author: wtrocki

.github/workflows/autoupdate-prod.yaml

@@ -32,6 +32,8 @@ jobs:
       - name: Release updates
         if: steps.verify-changed-files.outputs.files_changed == 'true'
         working-directory: ./tools
+        env: 
+          GIT_BASE_REF: ${{ github.event.pull_request.base.sha || github.event.merge_group.base_sha }}
         run: |
           make new-release  
       - uses: peter-evans/create-pull-request@v5
@@ -64,14 +66,9 @@ jobs:
             ## Manual Review Procedure
 
             1. Review changes in the OpenAPI file (openapi/atlas-api.yaml)
-            2. If we see any breaking changes [without a new resource version](https://github.com/mongodb/atlas-sdk-go/tree/main/tools/releaser#new-resource-version).
-              - View the log of breaking changes in the `Detect Breaking Changes` action
-              - Checkout PR locally and run `make update-version`
-              - Provide breaking changes information in generated `./releaser/breaking_changes/{release_version}.md` file
-              - Push your changes directly to the automation PR. 
-            3. If we have a major version release request feedback from additional reviewers if possible.
-            4. Merge PR into the main branch 
-            5. After the merge automated release process will be triggered. 
+            2. Review breaking changes information in generated `./releaser/breaking_changes/{release_version}.md` file
+            3. Merge PR into the main branch 
+            4. After the merge automated release process will be triggered. 
             
           
 

.github/workflows/breaking-changes.yaml

@@ -19,13 +19,6 @@ In situations where we do not want to perform automatic release please remove ch
 
 Manual release is possible by updating `./internal/core/version.go` file with minor version bump.
 
-## Manual Major Release
-
-For major releases (breaking changes) introduced outside new Resource Version.
-
-1. Run `make update-version` command
-2. Provide list of breaking changes in [BREAKING_CHANGES.md](https://github.com/mongodb/atlas-sdk-go/blob/main/BREAKING_CHANGES.md)
-
 ## Automation Process Internals
 
 Automation reads Resource Version in the `version.go` file and in the OpenAPI `versions.json`
@@ -37,17 +30,20 @@ For the new Resource Version introduced in the versions.json
 - Reset the minor version
 - Replace all occurrences of the Major version in the repository
 - Update versions in versions.go
+- Generate breaking changes file
 
-### New Generation
+### New SDK Generation without change in Rersource version
 
 - Issue new Minor release
 - Update versions in versions.go
 
-### Manual Breaking Changes Release
+### Breaking Changes Release
+
+In situations when breaking changes are present automation will recognize them and automatically create major version bump.
 
-- Read versions in versions.go
 - Automatically bump the Major version in versions.go
 - Replace all occurrences of the Major version in the repository
+- Generate breaking changes file
 
 ## Release Notes
 

tools/releaser/README.md

@@ -0,0 +1,28 @@
+#!/bin/bash
+set +e
+GOPATH=$(go env GOPATH)
+
+# Inputs:
+# GIT_BASE_REF - The base REF of the git repository
+# Usually "${{ github.event.pull_request.base.sha || github.event.merge_group.base_sha }}" 
+# TARGET_BREAKING_CHANGES_FILE - file to save breaking changes
+script_path=$(dirname "$0")
+
+echo "Installing go-apidiff"
+go install github.com/joelanford/go-apidiff@latest
+
+echo "Running breaking changes check"
+BREAKING_CHANGES=$("$GOPATH/bin/go-apidiff" "$GIT_BASE_REF" --compare-imports="false" --print-compatible="false" --repo-path="../")
+
+if [ -z "$BREAKING_CHANGES" ]; then
+  echo "No breaking changes detected"
+else
+  if [ -z "$TARGET_BREAKING_CHANGES_FILE" ]; then
+    echo "Breaking changes detected"
+    echo "$BREAKING_CHANGES"
+  else
+    echo "Creating breaking changes file"
+    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

tools/releaser/scripts/breaking-changes.sh

@@ -17,16 +17,28 @@ if [ "$NEW_RESOURCE_VERSION" == "$SDK_RESOURCE_VERSION" ]; then
 	new_minor_version=$((SDK_MINOR_VERSION + 1))
 	# Update the SDK_VERSION
 	SDK_VERSION="${SDK_MAJOR_VERSION}.${new_minor_version}.0"
+
+	echo "Print breaking changes"	
+	# shellcheck source=/dev/null
+	source "$script_path/breaking-changes.sh"
+	if [ -n "$BREAKING_CHANGES" ]; then
+		echo "BREAKING CHANGES DETECTED FOR NON MAJOR VERSION BUMP"
+		# shellcheck source=/dev/null
+		source "$script_path/update-version.sh"
+		exit 0;
+	fi
 else	 
 	# Update the SDK_VERSION
 	echo "Resource Version is not up to date. Changing major version."
-	NEW_MAJOR_VERSION="${NEW_RESOURCE_VERSION}001"
-	SDK_VERSION="v${NEW_MAJOR_VERSION}.0.0" 
+	NEW_MAJOR_VERSION="v${NEW_RESOURCE_VERSION}001"
+	SDK_VERSION="${NEW_MAJOR_VERSION}.0.0" 
+	echo "generate breaking changes file"	
+	export TARGET_BREAKING_CHANGES_FILE=${NEW_MAJOR_VERSION}
+	# shellcheck source=/dev/null
+	source "$script_path/breaking-changes.sh"
+
 	echo "Modifying all instances of version from $SDK_RESOURCE_VERSION to $NEW_RESOURCE_VERSION across the repository."
 	npm exec -c "replace-in-file /$SDK_MAJOR_VERSION/g $NEW_MAJOR_VERSION $VERSION_UPDATE_PATHS --isRegex"
-	echo "Creating empty breaking changes file for $NEW_MAJOR_VERSION"
-	echo -e "# Breaking Changes \n https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog" \
-		> "$script_path/../breaking_changes/${NEW_MAJOR_VERSION}.md"
 fi 
 
 echo "Creating new version.go file with $SDK_VERSION and resource version: $NEW_RESOURCE_VERSION"

tools/releaser/scripts/new-version.sh

@@ -11,16 +11,15 @@ source "$script_path/version-paths.sh"
 echo "Current Resource Version: $NEW_RESOURCE_VERSION"
 
 major_version_breaking_changes="${SDK_MAJOR_VERSION: -3}"
+# Remove leading zeros from the variable
+major_version_breaking_changes=${major_version_breaking_changes#00}
 major_version_bump=$((major_version_breaking_changes+1))
 major_version_bump=$(printf "%03d" "$major_version_bump")
 BUMPED_MAJOR_VERSION="v${SDK_RESOURCE_VERSION}${major_version_bump}"
 
 echo "Modifying $SDK_MAJOR_VERSION to $BUMPED_MAJOR_VERSION Resource Version across the repository."
 npm exec -c "replace-in-file /$SDK_MAJOR_VERSION/g $BUMPED_MAJOR_VERSION $VERSION_UPDATE_PATHS --isRegex"
 
-echo "Creating empty breaking changes file for $BUMPED_MAJOR_VERSION"
-echo "# Breaking Changes" > "$script_path/../breaking_changes/${BUMPED_MAJOR_VERSION}.md"
-
 ## Explicitly update version.go file
 export SDK_VERSION="${BUMPED_MAJOR_VERSION}.0.0"
 export NEW_RESOURCE_VERSION="${SDK_RESOURCE_VERSION}"
@@ -29,3 +28,6 @@ echo "Updating version.go file: $SDK_VERSION"
 target_file_path="$script_path/../../../internal/core/version.go"
 envsubst < "$script_path/../templates/VERSION.tmpl" > "$target_file_path"
 
+export TARGET_BREAKING_CHANGES_FILE=${BUMPED_MAJOR_VERSION}
+# shellcheck source=/dev/null
+source "$script_path/breaking-changes.sh"