spec icon indicating copy to clipboard operation
spec copied to clipboard

feat!: move operations to its own root object

Open fmvilas opened this issue 2 years ago β€’ 11 comments


title: "Move operations to its own root object"


Related issue(s):

#618 #663


fmvilas avatar Jun 13 '22 13:06 fmvilas

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

sonarcloud[bot] avatar Jul 19 '22 10:07 sonarcloud[bot]

/progress 60

New operations object is defined but there's still a pending discussion about how to reference the channel, i.e., via ID or $ref object. Read more on #663.

fmvilas avatar Sep 06 '22 19:09 fmvilas

/progress 20

did it work :trollface:? or did you make sure that only your "progress comments" are taken into account? πŸ˜„

and regarding PR:

  • please add new object to ToC of the spec
  • it is a new root object, so should be added to AsyncAPI Object
  • I'm definitely up with using $ref for channel reference, let's be consistent everywhere though
  • I'm guessing the message goes away from operation as it stays in the channel, right? and it is handled here https://github.com/asyncapi/spec/pull/827/ so all good from my side

New operations object is defined but there's still a pending discussion about how to reference the channel, i.e., via ID or $ref object. Read more on https://github.com/asyncapi/spec/issues/663.

@fmvilas I think we just need @dalelane view on that, or are you waiting for someone else?

derberg avatar Sep 07 '22 15:09 derberg

/progress 60

did it work :trollface:? or did you make sure that only your "progress comments" are taken into account? πŸ˜„

It did work because it's meant to be used as a team so I just have to rely on the hope that you would not troll me so much πŸ˜… (damn, as I'm writing this I'm already realizing I'm dead πŸ˜‚)

I think we just need @dalelane view on that, or are you waiting for someone else?

Dale's point of view for sure. Would also love to have the opinions of β€”at leastβ€” @smoya, @char0n, and @magicmatatjahu. And of course, anyone else reading this is also welcome. I know you know but just so everyone knows :)


Regarding the review, thanks! I'll address all those points πŸ‘

fmvilas avatar Sep 09 '22 11:09 fmvilas

Alright, I think I addressed all the points @derberg. Would you please review it again?

fmvilas avatar Sep 09 '22 12:09 fmvilas

just to be clear, after we merge it, a release candidate will be released and published on the website

πŸ€” Should we avoid it for now? I just want to make progress towards 3.0.0 but we're still far. Should I use chore in this case?

fmvilas avatar Sep 12 '22 20:09 fmvilas

tbh, I'm pro-pre-releases πŸ˜„ as they raise awareness. They will be published to asyncapi.com and will make it pretty clear to users going to "docs" that 3.0 is on the horizon. Docs is the most visited part of the website. We could add some big note at the beginning of the spec file, with some essential links on how to engage in works towards 3.0, just a thought.

derberg avatar Sep 12 '22 21:09 derberg

We could add some big note at the beginning of the spec file, with some essential links on how to engage in works towards 3.0, just a thought.

That's a good idea. Will add it.

fmvilas avatar Sep 12 '22 21:09 fmvilas

@derberg done. Let me know what you think.

fmvilas avatar Sep 12 '22 21:09 fmvilas

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

sonarcloud[bot] avatar Sep 13 '22 20:09 sonarcloud[bot]

@fmvilas

  • please remember not to merge this PR until https://github.com/asyncapi/spec/pull/759#issuecomment-1253666349 is solved and the release workflow, otherwise we are not able to release RC
  • update PR title to feat!: as we are actually suppose to release a major release candidate

derberg avatar Sep 21 '22 13:09 derberg

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

sonarcloud[bot] avatar Sep 22 '22 15:09 sonarcloud[bot]

@dalelane mind having a look?

fmvilas avatar Sep 23 '22 13:09 fmvilas

/rtm

fmvilas avatar Sep 26 '22 14:09 fmvilas

:tada: This PR is included in version 3.0.0-next-major-spec.1 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket:

asyncapi-bot avatar Sep 26 '22 14:09 asyncapi-bot