chore(cdn): re-tag of cdn module v2 versions to prevent module path change (#3842)

Author: rubenhoenle

CHANGELOG.md

@@ -10,7 +10,8 @@
     - Add `Etag` field to `Role` model struct
   - [v0.9.1](services/authorization/CHANGELOG.md#v091) 
     - Bump STACKIT SDK core module from `v0.19.0` to `v0.20.0`
-- `cdn`: [v2.1.1](services/cdn/CHANGELOG.md#v211) 
+- `cdn`: [v1.8.1](services/cdn/CHANGELOG.md#v181) (formerly `v2.1.1`)
+  - **Note: This release was formerly known as `v2.1.1` and was re-tagged as `v1.8.1`, see statement in the [changelog of the STACKIT CDN SDK module](services/cdn/CHANGELOG).**
   - Bump STACKIT SDK core module from `v0.19.0` to `v0.20.0`
 - `certificates`: [v1.1.2](services/certificates/CHANGELOG.md#v112) 
   - Bump STACKIT SDK core module from `v0.19.0` to `v0.20.0`
@@ -98,7 +99,8 @@
     - **Feature:** Add new field `ImportProgress` to `Image` model, which indicates the import progress of an image
   - [v1.1.0](services/iaas/CHANGELOG.md#v110)
     - **Breaking Change:** Removal of unused model structs: `Area`, `AreaConfig`, `AreaPrefixConfigIPv4`, `UpdateAreaIPv4`, `NetworkAreaIPv4`, `CreateAreaAddressFamily`, `CreateAreaIPv4`, `CreateNetworkAddressFamily`, `CreateNetworkIPv4Body`, `CreateNetworkIPv6Body`, `CreateServerPayloadBootVolume`, `CreateServerPayloadNetworking`, `NullableUpdateAreaAddressFamily`, `CreateServerPayloadNetworking`, `UpdateNetworkAddressFamily`, `CreateServerPayloadNetworking`, `CreateServerPayloadNetworking`
-- `cdn`: [v2.1.0](services/cdn/CHANGELOG.md#v210)
+- `cdn`: [v1.8.0](services/cdn/CHANGELOG.md#v180) (formerly `v2.1.0`)
+  - **Note: This release was formerly known as `v2.1.0` and was re-tagged as `v1.8.0`, see statement in the [changelog of the STACKIT CDN SDK module](services/cdn/CHANGELOG).**
   - **Breaking change:** Removal of unused model structs: `GetLogsSearchFiltersResponse`, `PatchLokiLogSink`
 - `kms`: [v1.1.0](services/kms/CHANGELOG.md#v110)
   - **Bugfix:** Ensure correct state checking in `DisableKeyVersionWaitHandler` and `EnableKeyVersionWaitHandler`
@@ -139,7 +141,8 @@
   - **Feature:** Add support for list runner labels operation
     - new API client methods `ListRunnerLabels` and `ListRunnerLabelsExecute`
     - new model struct `RunnerLabel`
-- `cdn`: [v2.0.0](services/cdn/CHANGELOG.md#v200)
+- `cdn`: [v1.7.0](services/cdn/CHANGELOG.md#v170) (formerly `v2.0.0`)
+  - **Note: This release was formerly known as `v2.0.0` and was re-tagged as `v1.7.0`, see statement in the [changelog of the STACKIT CDN SDK module](services/cdn/CHANGELOG).**
   - **Feature:** Switch from `v1beta` CDN API version to `v1beta2` version.
   - **Breaking change:** Changed spelling from `WAF` to `Waf` in model struct names
     - `WAFStatusRuleBlock` -> `WafStatusRuleBlock`

Makefile

@@ -44,9 +44,12 @@ sync-tidy: ## Sync and tidy dependencies
 	@echo ">> Syncing and tidying dependencies"
 	@$(SCRIPTS_BASE)/sync-tidy.sh
 
-lint: sync-tidy ## Lint all code
+lint: sync-tidy lint-versions ## Lint all code
 	@$(MAKE) --no-print-directory lint-golangci-lint skip-non-generated-files=${skip-non-generated-files} service=${service}
 
+lint-versions:
+	@go run $(SCRIPTS_BASE)/lint-versions.go
+
 # TEST
 test-go: ## Run Go tests
 	@echo ">> Running Go tests"
@@ -59,10 +62,3 @@ test-scripts: ## Run tests for scripts
 test: ## Run all tests
 	@$(MAKE) --no-print-directory test-go skip-non-generated-files=${skip-non-generated-files} service=${service}
 
-# AUTOMATIC TAG
-sdk-tag-services:
-	@go run $(SCRIPTS_BASE)/automatic_tag.go --update-type ${update-type} --ssh-private-key-file-path ${ssh-private-key-file-path};
-
-
-sdk-tag-core: 
-	@go run $(SCRIPTS_BASE)/automatic_tag.go --update-type ${update-type} --ssh-private-key-file-path ${ssh-private-key-file-path} --target core;

scripts/lint-versions.go

@@ -0,0 +1,65 @@
+package main
+
+import (
+	"fmt"
+	"io/fs"
+	"log"
+	"os"
+	"path/filepath"
+	"regexp"
+	"strings"
+)
+
+const (
+	targetFileName = "VERSION"
+)
+
+var (
+	targetDirs = []string{"services", "core"}
+)
+
+func main() {
+	fmt.Println(">> Linting SDK module versions...")
+
+	// e.g., versions["services/iaas"] = "v1.2.3"
+	versions := make(map[string]string)
+
+	for _, rootDir := range targetDirs {
+		err := filepath.WalkDir(rootDir, func(path string, d fs.DirEntry, err error) error {
+			if err != nil {
+				return fmt.Errorf("error accessing path %s: %w", path, err)
+			}
+
+			if d.IsDir() && d.Name() == ".openapi-generator" {
+				return filepath.SkipDir
+			}
+
+			if !d.IsDir() && d.Name() == targetFileName {
+				content, err := os.ReadFile(path)
+				if err != nil {
+					return fmt.Errorf("could not read file %s: %v", path, err)
+				}
+
+				dirPath := filepath.Dir(path)
+				version := strings.TrimSpace(string(content))
+
+				versions[dirPath] = version
+			}
+
+			return nil
+		})
+
+		if err != nil {
+			log.Fatalf("failed to walk directory %s: %v", rootDir, err)
+		}
+	}
+
+	re := regexp.MustCompile(`^v[0-1]\.\d+\.\d+$`)
+	for dir, version := range versions {
+		versionOk := re.MatchString(version)
+
+		if !versionOk {
+			log.Fatalf("Invalid version for %s: %s\n", dir, version)
+		}
+	}
+}

scripts/update-service-tags.sh

@@ -10,17 +10,17 @@ set -e
 for file in $(git diff --name-only HEAD~1..HEAD | grep -E "(^services/[^/]+/VERSION$|^core/VERSION$)"); do
 
     # Extract the current version and build the expected tag
-    dirpath=$(dirname $file)
+    dirpath=$(dirname "$file")
     version_path="$dirpath/VERSION"
     version=$(<"$version_path")
     expected_tag="$dirpath/$version"
     # Check if the tag already exists
-    if git rev-parse --verify $expected_tag &> /dev/null; then
+    if git rev-parse --verify "$expected_tag" &> /dev/null; then
         echo "Tag '$expected_tag' already exists."
     else
         # Tag doesn't exist. Create a tag and push it.
         echo "Tag '$expected_tag' does not exist."
-        git tag -a $expected_tag -m "Release $version"
-        git push origin tag $expected_tag
+        git tag -a "$expected_tag" -m "Release $version"
+        git push origin tag "$expected_tag"
     fi
 done

services/cdn/CHANGELOG.md

@@ -1,10 +1,25 @@
-## v2.1.1
-  - Bump STACKIT SDK core module from `v0.19.0` to `v0.20.0`
-
-## v2.1.0
+## v1.8.1
+- **Note: This release was formerly known as `v2.1.1` and was re-tagged, see statement below.**
+- Bump STACKIT SDK core module from `v0.19.0` to `v0.20.0`
+
+> [!IMPORTANT]
+> The 3 releases, which contained the previously tagged `v2.x.x` changes, are now re-released as `v1.7.0`, `v1.8.0` and `v1.8.1`.
+> We have retagged the releases as `v1.x.x` versions to avoid forcing a module path change on all consumers.
+>
+> **Reason:** According to [Go module conventions](https://go.dev/blog/v2-go-modules), major versions ≥2 require the module path to be updated with a `/v2` suffix (`github.com/stackitcloud/stackit-sdk-go/services/cdn`).
+>
+> **Impact:** By remaining at `v1`, all users can continue to import the module using the original, clean import path (`github.com/stackitcloud/stackit-sdk-go/services/cdn`) without needing to update their import statements.
+>
+> **Note: If you were trying to use any `v2.x.x` tag, please downgrade to `v1.7.0` or higher. There won't be any `v2.x.x` release in the near future of any STACKIT SDK module.**
+>
+> We apologize for any confusion caused by the `v2.x.x` tags. We have a linter in place to prevent this in the future.
+
+## v1.8.0
+- **Note: This release was formerly known as `v2.1.0` and was re-tagged, see statement above.**
 - **Breaking change:** Removal of unused model structs: `GetLogsSearchFiltersResponse`, `PatchLokiLogSink`
 
-## v2.0.0
+## v1.7.0
+- **Note: This release was formerly known as `v2.0.0` and was re-tagged, see statement above.**
 - **Feature:** Switch from `v1beta` CDN API version to `v1beta2` version.
 - **Breaking change:** Changed spelling from `WAF` to `Waf` in model struct names
   - `WAFStatusRuleBlock` -> `WafStatusRuleBlock`

services/cdn/VERSION

@@ -1 +1 @@
-v2.1.1
+v1.8.1