Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add link to release notes #88

Merged
merged 1 commit into from
Jun 21, 2024
Merged

docs: add link to release notes #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/configuration/documenting-bindings.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading