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.

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

chore: update examples to v3 #947

Merged
merged 10 commits into from
Aug 2, 2023

Conversation

jonaslagoni
Copy link
Member

This PR updates all examples to v3, as well as introducing a tool that automates the process for the next releases, by utilizing the converter.

@jonaslagoni jonaslagoni mentioned this pull request Jun 22, 2023
@sonarcloud
Copy link

sonarcloud bot commented Jun 22, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@jonaslagoni
Copy link
Member Author

rpc-client was using a parameter with pattern: ^amq\\.gen\\-.+$
rpc-server was using a parameter withpattern: ^amq\\.gen\\-.+$

Which both are no longer supported.

@jonaslagoni jonaslagoni marked this pull request as ready for review July 26, 2023 09:50
Copy link
Collaborator

@Amzani Amzani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great PR! that our doc contributors are waiting for 🚀
Only small typo.
If we merge this with main, we will loose all the old 2.x.x examples? is this the intention ?

version: '1.0.0'
description: A cut of the Streetlights API to test application header changes supporting #112
version: 1.0.0
description: A cut of the Streetlights API to test application header changes supporting
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jonaslagoni #112 is missing here, otherwise the meaning is not correct.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, it's a bug with the converter 🤔

Mind adding a bug issue?

receiveLightMeasurement:
action: receive
channel:
$ref: >-
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't knew this notion >- is it to allow multi-lines in that case why not having #/channels/smartylighting~1streetlights~11~10~1event~1{streetlightId}~1lighting~1measured in the same line.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's part of the converter logic somewhere 🤔

Might be because the string is too long 🧐

@jonaslagoni
Copy link
Member Author

If we merge this with main, we will loose all the old 2.x.x examples? is this the intention ?

It is yes.

We can keep a copy of the v2 examples if we want in a sub directory 🤔

@sonarcloud
Copy link

sonarcloud bot commented Aug 2, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@derberg
Copy link
Member

derberg commented Aug 2, 2023

We can keep a copy of the v2 examples if we want in a sub directory 🤔

I don't think we should do it,
Better just extend Examples section with information where examples prior 3.0 can be found -> under release tag (we can provide link)

basically master shows latest, just like it is with the spec

@derberg derberg requested a review from Amzani August 2, 2023 14:29
Copy link
Collaborator

@Amzani Amzani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jonaslagoni
Copy link
Member Author

/rtm

@jonaslagoni
Copy link
Member Author

Thanks folks 😄

@asyncapi-bot asyncapi-bot merged commit c37d745 into asyncapi:next-major-spec Aug 2, 2023
25 of 26 checks passed
@jonaslagoni jonaslagoni deleted the update_examples branch August 2, 2023 22:16
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 3.0.0-next-major-spec.13 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants