fix: go module version now supports v4 (#377)

asyncapi · Apr 19, 2023 · 1d04d09 · 1d04d09
1 parent 0ebe4f4
commit 1d04d09
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -85,7 +85,7 @@ const asyncapi = versions['1.1.0'];
 Grab a specific AsyncAPI version:
 
 ```go
-import "github.com/asyncapi/spec_json_schemas/v2"
+import "github.com/asyncapi/spec_json_schemas/v4"
 
 func Do() {
     schema, err := spec_json_schemas.Get("1.1.0")
@@ -151,4 +151,9 @@ The manual process of creating a new version is to:
           }
        ]
     }
-    ```
+    ```
+
+### Handling breaking changes
+Whenever a Breaking Change is introduced, the following steps should be taken in Go package:
+
+1. Edit `go.mod` file, and increase the version package suffix in the module name. For example, if the current version is `v2.0.0`, and you are releasing `v3.0.0`, the module name should be `github.com/asyncapi/spec-json-schemas/v3`.
diff --git a/go.mod b/go.mod
@@ -1,4 +1,4 @@
-module github.com/asyncapi/spec-json-schemas/v2
+module github.com/asyncapi/spec-json-schemas/v4
 
 go 1.17