feat: make server variables reuseable #174

danielkocot · 2022-02-14T12:51:20Z

Description

This PR adds serverVariables as reusable objects to be used in components.

github-actions

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

sonarqubecloud · 2022-02-14T12:51:41Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

smoya · 2022-02-16T11:52:28Z

For the record, here is the diff between 2.3.0.json and 2.4.0.json (introduced here):

➜  diff -u <(curl -s https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/2.3.0.json) <(curl -s https://raw.githubusercontent.com/asyncapi/spec-json-schemas/0af02c5b2799ae0ea23bb07e13e57d95d5a1dc60/schemas/2.4.0.json)

--- /dev/fd/11  2022-02-16 12:55:18.730955251 +0100
+++ /dev/fd/12  2022-02-16 12:55:18.731524237 +0100
@@ -1,5 +1,5 @@
 {
-  "title": "AsyncAPI 2.3.0 schema.",
+  "title": "AsyncAPI 2.4.0 schema.",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "required": [
@@ -17,7 +17,7 @@
     "asyncapi": {
       "type": "string",
       "enum": [
-        "2.3.0"
+        "2.4.0"
       ],
       "description": "The AsyncAPI specification version of this document."
     },
@@ -270,6 +270,9 @@
         "servers": {
           "$ref": "#/definitions/servers"
         },
+        "serverVariables": {
+          "$ref": "#/definitions/serverVariables"
+        },
         "channels": {
           "$ref": "#/definitions/channels"
         },

smoya

LGTM, However I'm not a Code Owner.

I think we would need to create a new release branch for the next minor and point this PR to it.

Any thoughts? cc @fmvilas @derberg

fmvilas

LGTM 👍

fmvilas · 2022-02-17T19:44:50Z

/dnm

fmvilas · 2022-02-17T19:45:14Z

Let's wait for @derberg and @dalelane review too.

dalelane

I think @smoya is right that we can't merge this into master as-is so we need to either park it for a bit, or switch the PR to target somewhere ready for the next release.

But those git-logistics aside, this looks like a good idea to me

derberg · 2022-03-09T14:00:04Z

we need to find volunteer to run 2.4.0 release coordination 😓

smoya · 2022-03-09T14:39:23Z

@derberg we need a next branch so we can merge the code that will be released in 2.4.0.

smoya · 2022-03-09T14:40:52Z

we need to find volunteer to run 2.4.0 release coordination 😓

I volunteer 👍

derberg · 2022-03-10T12:42:10Z

I volunteer 👍

oh, that was easy ❤️

branches created:

I highly recommend you start coordinating by opening an issue just like proposed by @dalelane in this PR and also using his updated release process instructions. I left few comments that but majority of the content is what should be followed

smoya · 2022-03-10T13:52:21Z

I volunteer 👍

oh, that was easy ❤️

branches created:

https://github.com/asyncapi/spec/tree/2022-04-release

https://github.com/asyncapi/spec-json-schemas/tree/2022-04-release

https://github.com/asyncapi/parser-js/tree/2022-04-release

I highly recommend you start coordinating by opening an issue just like proposed by @dalelane in this PR and also using his updated release process instructions. I left few comments that but majority of the content is what should be followed

I thought we would finally follow semantic-release and instead use next branches (as we do for next-major) for those releases.

I suggested it in the past in Slack as well: https://asyncapi.slack.com/archives/C0230UAM6R3/p1644418043568169

derberg · 2022-03-14T12:14:10Z

I thought we would finally follow semantic-release and instead use next branches (as we do for next-major) for those releases.
I suggested it in the past in Slack as well: https://asyncapi.slack.com/archives/C0230UAM6R3/p1644418043568169

well I remember the discussion about next-major but do not recall being involved in the discussion about spec release branches that are named after release cadence. I personally like the current names of release branches, they clearly indicate what you can expect + they make sense as you know when you release, while with next you clearly not. Anyway, if you want to change it you need to start open discussion as for now it is part of https://github.com/asyncapi/spec/blob/master/RELEASE_PROCESS.md and was agreed in a discussion about release cadence asyncapi/spec#513. Just clear explain what are the benefits.

smoya · 2022-03-14T18:01:50Z

Anyway, if you want to change it you need to start open discussion as for now it is part of https://github.com/asyncapi/spec/blob/master/RELEASE_PROCESS.md and was agreed in a discussion about release cadence asyncapi/spec#513. Just clear explain what are the benefits.

I ended up creating such issue asyncapi/spec#734! Thanks @derberg for your suggestion!

smoya · 2022-03-15T15:34:00Z

~~@danielkocot we have now the release branches for 2.4.0. Would you mind changing the base branch to 2022-04-release ? Thanks!~~

EDIT: NVM! better to wait first #182 to be merged. Then I will ping you again. Thanks.

derberg · 2022-04-05T10:52:52Z

@smoya we still have it scheduled for April right?

smoya · 2022-04-05T10:54:07Z

@smoya we still have it scheduled for April right?

Yes, we do. asyncapi/spec#735

smoya · 2022-04-05T10:54:52Z

@danielkocot would you mind updating your branch with latest upstream changes? It seems there are some conflicts.

fmvilas · 2022-04-13T15:28:02Z

I'm seeing a lot of changes in Markdown files. Is that expected? 🤔

smoya · 2022-04-13T15:58:56Z

/autoupdate

smoya · 2022-04-13T16:14:30Z

I'm seeing a lot of changes in Markdown files. Is that expected? 🤔

I think for some reason, target branch didn't get updated with master branch changes, and those changes introduced in 7e9a2a3 are not in there.
Will see what is happening.

derberg

all good but I see some conflicts there that will block merging

smoya · 2022-04-20T11:24:05Z

@danielkocot We are almost there! Only one thing pending: would you mind fixing the merge conflicts? After you do it, I will merge it.

sonarqubecloud · 2022-04-20T20:14:39Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

smoya · 2022-04-21T09:41:40Z

/rtm

asyncapi-bot · 2022-04-21T09:45:42Z

🎉 This PR is included in version 2.14.0-2022-04-release.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

make server variables reuseable

0af02c5

github-actions bot reviewed Feb 14, 2022

View reviewed changes

danielkocot mentioned this pull request Feb 14, 2022

feat: added server variable object as reusable object asyncapi/spec#717

Merged

smoya reviewed Feb 16, 2022

View reviewed changes

fmvilas approved these changes Feb 17, 2022

View reviewed changes

asyncapi-bot added the do-not-merge label Feb 17, 2022

fmvilas requested review from dalelane and derberg February 17, 2022 19:45

dalelane approved these changes Feb 18, 2022

View reviewed changes

danielkocot mentioned this pull request Feb 21, 2022

feat: add methods and tests for serverVariables asyncapi/parser-js#476

Merged

smoya mentioned this pull request Mar 21, 2022

Work on 2.4 release asyncapi/spec#735

Closed

55 tasks

danielkocot changed the base branch from master to 2022-04-release March 21, 2022 19:27

danielkocot requested a review from asyncapi-bot-eve as a code owner March 21, 2022 19:27

Merge branch 'asyncapi:master' into 2-4-0-server-variables-reuseable

7e9a2a3

asyncapi-bot added the autoupdate label Apr 13, 2022

smoya mentioned this pull request Apr 19, 2022

Make Server Variables Object available as reusable objects under the Component object asyncapi/spec#707

Closed

derberg approved these changes Apr 20, 2022

View reviewed changes

derberg removed the do-not-merge label Apr 20, 2022

Merge branch '2022-04-release' into 2-4-0-server-variables-reuseable

cdfb42a

asyncapi-bot added the ready-to-merge label Apr 21, 2022

asyncapi-bot merged commit c10567f into asyncapi:2022-04-release Apr 21, 2022

asyncapi-bot added the released on @2022-04-release label Apr 21, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: make server variables reuseable #174

feat: make server variables reuseable #174

danielkocot commented Feb 14, 2022

github-actions bot left a comment

sonarqubecloud bot commented Feb 14, 2022

smoya commented Feb 16, 2022 •

edited

Loading

smoya left a comment

fmvilas left a comment

fmvilas commented Feb 17, 2022

fmvilas commented Feb 17, 2022

dalelane left a comment

derberg commented Mar 9, 2022

smoya commented Mar 9, 2022

smoya commented Mar 9, 2022

derberg commented Mar 10, 2022

smoya commented Mar 10, 2022 •

edited

Loading

derberg commented Mar 14, 2022

smoya commented Mar 14, 2022

smoya commented Mar 15, 2022 •

edited

Loading

derberg commented Apr 5, 2022

smoya commented Apr 5, 2022

smoya commented Apr 5, 2022

fmvilas commented Apr 13, 2022

smoya commented Apr 13, 2022

smoya commented Apr 13, 2022

derberg left a comment

smoya commented Apr 20, 2022 •

edited

Loading

sonarqubecloud bot commented Apr 20, 2022

smoya commented Apr 21, 2022

asyncapi-bot commented Apr 21, 2022

feat: make server variables reuseable #174

feat: make server variables reuseable #174

Conversation

danielkocot commented Feb 14, 2022

github-actions bot left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Feb 14, 2022

smoya commented Feb 16, 2022 • edited Loading

smoya left a comment

Choose a reason for hiding this comment

fmvilas left a comment

Choose a reason for hiding this comment

fmvilas commented Feb 17, 2022

fmvilas commented Feb 17, 2022

dalelane left a comment

Choose a reason for hiding this comment

derberg commented Mar 9, 2022

smoya commented Mar 9, 2022

smoya commented Mar 9, 2022

derberg commented Mar 10, 2022

smoya commented Mar 10, 2022 • edited Loading

derberg commented Mar 14, 2022

smoya commented Mar 14, 2022

smoya commented Mar 15, 2022 • edited Loading

derberg commented Apr 5, 2022

smoya commented Apr 5, 2022

smoya commented Apr 5, 2022

fmvilas commented Apr 13, 2022

smoya commented Apr 13, 2022

smoya commented Apr 13, 2022

derberg left a comment

Choose a reason for hiding this comment

smoya commented Apr 20, 2022 • edited Loading

sonarqubecloud bot commented Apr 20, 2022

smoya commented Apr 21, 2022

asyncapi-bot commented Apr 21, 2022

smoya commented Feb 16, 2022 •

edited

Loading

smoya commented Mar 10, 2022 •

edited

Loading

smoya commented Mar 15, 2022 •

edited

Loading

smoya commented Apr 20, 2022 •

edited

Loading