Skip to content

Commit

Permalink
Merge branch 'master' into fixbundleforvscode
Browse files Browse the repository at this point in the history
  • Loading branch information
derberg authored Apr 19, 2023
2 parents 0419b24 + 996549e commit a270f3f
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 4 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ console.log(Object.keys(versions));
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")
Expand Down Expand Up @@ -172,3 +172,8 @@ 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`.
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/asyncapi/spec-json-schemas/v2
module github.com/asyncapi/spec-json-schemas/v4

go 1.17

Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@asyncapi/specs",
"version": "4.2.0",
"version": "4.2.1",
"description": "AsyncAPI schema versions",
"main": "index.js",
"types": "index.d.ts",
Expand Down

0 comments on commit a270f3f

Please sign in to comment.