chore: Use a fix version for Preview (#443)

Author: lantoli

.github/workflows/autoupdate-preview.yaml

@@ -32,6 +32,10 @@ jobs:
         run: |
           export PATH=${PATH}:`go env GOPATH`/bin
           make clean_and_generate
+      - name: Update Preview version
+        if: steps.verify-changed-files.outputs.files_changed == 'true'
+        working-directory: ./tools
+        run: make preview-version  
       - name: Run mock generation
         working-directory: ./tools
         if: steps.verify-changed-files.outputs.files_changed == 'true'
@@ -44,7 +48,7 @@ jobs:
           commit-message: "temp: client update"
           delete-branch: true
           draft: true
-          branch: dev-latest
+          branch: preview-latest
           body: |
             Automatic update for MongoDB Atlas Go Client based on *release candidate* OpenAPI file.
             **DO NOT MERGE THIS PR TO THE MAIN BRANCH**
@@ -56,9 +60,24 @@ jobs:
             ## Using early preview changes
 
             ```sh
-            go get go.mongodb.org/atlas-sdk/v20240805005@dev-latest   
+            go get github.com/mongodb/atlas-sdk-go@preview-latest
+            ```
+            > NOTE: The version is fixed so you have to do the `go get` command every time you want to update the Preview version to the latest version.
+
+            After that you can use it as usual, e.g.:
+            ```go
+            ...
+            import(
+              adminPreview "github.com/mongodb/atlas-sdk-go/admin"
+            ...
+              		
+            params := &adminPreview.ListProjectsApiParams{ ...
+            ...
+            
             ```
 
+            > NOTE: After you use it at least in one go file, run `go mod tidy` to have it in your go.mod file as a direct dependency.
+
             ## Automated checks done for preview sdk
 
             1. Compilation and unit tests

.github/workflows/autoupdate-prod.yaml

@@ -49,7 +49,7 @@ jobs:
       - name: Release updates
         if: steps.verify-changed-files.outputs.files_changed == 'true'
         working-directory: ./tools
-        run: make new-release  
+        run: make new-version  
       - name: Ensure all markdown code is formatted
         if: steps.verify-changed-files.outputs.files_changed == 'true'
         working-directory: ./tools

tools/CONTRIBUTING.md

@@ -50,3 +50,8 @@ https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-ge
 
 We use [go-apidiff](https://github.com/joelanford/go-apidiff) to detect if there are breaking changes and a new major version release is needed.
 In [Generate SDK Github action](../.github/workflows/autoupdate-prod.yaml), `API_DIFF_OLD_COMMIT` and `API_DIFF_NEW_COMMIT` are used to do the comparison.
+
+## SDK Preview
+
+The [Generate Preview SDK Github action](../.github/workflows/autoupdate-preview.yaml) creates a PR with latest changes.
+It's created in package `github.com/mongodb/atlas-sdk-go` instead of `go.mongodb.org/atlas-sdk/vXXXXXXXXXXX` so no official release is needed for Preview and it makes it clear that it's not a regular version.

tools/Makefile

@@ -33,10 +33,14 @@ generate_tests:
 	rm -Rf ../test/generated/test*
 	./scripts/generate_tests.sh
 
-.PHONY: new-release
-new-release:
+.PHONY: new-version
+new-version:
 	./releaser/scripts/new-version.sh
 
+.PHONY: preview-version
+preview-version:
+	./releaser/scripts/preview-version.sh
+
 .PHONY: update-version
 update-version:
 	## When manually updating major version

tools/releaser/scripts/preview-version.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+set -ueo pipefail
+
+script_path=$(dirname "$0")
+# shellcheck source=/dev/null
+source "$script_path/extract-version.sh"
+# shellcheck source=/dev/null
+source "$script_path/version-paths.sh"
+
+OLD_PACKAGE="go.mongodb.org/atlas-sdk/${SDK_MAJOR_VERSION}"
+NEW_PACKAGE="github.com/mongodb/atlas-sdk-go"
+examples_path="$script_path/../../../examples"
+
+echo "Delete specific version $SDK_MAJOR_VERSION from examples go.mod"
+(cd "$examples_path" && go mod edit -droprequire="$OLD_PACKAGE")
+
+echo "Modifying all instances from $OLD_PACKAGE to $NEW_PACKAGE across the repository."
+npm install
+npm exec -c "replace-in-file '/$OLD_PACKAGE/g' '$NEW_PACKAGE' $VERSION_UPDATE_PATHS_PREVIEW --isRegex"
+
+echo "Add preview version to examples go.mod"
+(cd "$examples_path" && go get $NEW_PACKAGE)

tools/releaser/scripts/version-paths.sh

@@ -1,3 +1,6 @@
 #!/bin/bash
 
-export VERSION_UPDATE_PATHS="../**/*.go,../**/*.md,../tools/**/*.mustache,../**/go.mod,../.github/workflows/autoupdate-preview.yaml,../.mockery.yaml"
+export VERSION_UPDATE_PATHS="../**/go.mod,../**/*.go,../tools/**/*.mustache,../.mockery.yaml,../**/*.md"
+
+# don't change doc files to reduce Preview PR noise
+export VERSION_UPDATE_PATHS_PREVIEW="../**/go.mod,../**/*.go,../tools/**/*.mustache,../.mockery.yaml"