Skip to content

Commit

Permalink
docs: add link to release notes (#88)
Browse files Browse the repository at this point in the history
Using multiple words so that users find this section when using the search.
  • Loading branch information
timonback committed Jun 21, 2024
1 parent 4a34639 commit f9b2613
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/configuration/documenting-bindings.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ The Message Binding Object is used to describe the Google Cloud Pub/Sub PubsubMe

`OrderingKey`: If non-empty, identifies related messages for which publish order should be respected

`Schema Definition`: The Schema Definition Object is used to describe the Google Cloud Pub/Sub Schema Object with AsyncAPI. While some of this information could be, or is, described using native AsyncAPI, for consistency it makes sense to provide this information here at all times, especially for cases where AsyncAPI doesn't natively support describing payloads using a supported Google Cloud Pub/Sub schema format like Protobuf
`Schema Definition`: The Schema Definition Object is used to describe the Google Cloud Pub/Sub Schema Object with AsyncAPI. While some of this information could be, or is, described using native AsyncAPI, for consistency it makes sense to always provide this information here, especially for cases where AsyncAPI doesn't natively support describing payloads using a supported Google Cloud Pub/Sub schema format like Protobuf

- name: The name of the schema

Expand Down
7 changes: 7 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,13 @@ class ListWrapper extends ArrayList<String> {}
public void sendMessage(ListWrapper<String> msg) {}
```

## Release Notes / Migration Guide / Updating / Upgrading

Releases are managed in [GitHub Releases](https://github.com/springwolf/springwolf-core/releases),
which feature noteworthy changes, the full changelog and notes on how to migrate.

Since each release has a git _tag_, the [Springwolf examples for each plugin](https://github.com/springwolf/springwolf-core/blob/master/springwolf-examples) showcase the use of Springwolf for any previous version.

### How to migrate from Springwolf 0.18.0 to 1.0.0

See [Release 1.0.0](https://github.com/springwolf/springwolf-core/releases/tag/v1.0.0).
Expand Down

0 comments on commit f9b2613

Please sign in to comment.