Fixes revapi configuration for merging #8936
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
npepinpe
force-pushed
the
8837-multi-revapi
branch
from
fb5c43e
to
5a986e9
Compare
Fixes revapi configuration to allow merging configurations together. This will let us leverage the CI support for `ignored-changes.json` files, which are for temporary breaking changes which should be removed from the revapi configuration once a new version is released. Essentially, you can split extension blocks across multiple files, but the extension within the same pipeline must have the exact same ID. When they have the same ID, they will be merged. Revapi doesn't do complex merging, the merging is purely additive: this means scalar properties (e.g. boolean, string, int, etc.) will fail when specified multiple times. Collections are merged, however, so two arrays will be concatenated. We chose to use the extension name without the `revapi.` prefix, simply because it's shorter than the extension name while still remaining descriptive.
npepinpe
force-pushed
the
8837-multi-revapi
branch
from
5a986e9
to
266a6be
Compare
|
bors merge |
ghost
pushed a commit
that referenced
this pull request
Mar 21, 2022
8936: Fixes revapi configuration for merging r=npepinpe a=npepinpe ## Description Fixes revapi configuration to allow merging configurations together. This will let us leverage the CI support for `ignored-changes.json` files, which are for temporary breaking changes which should be removed from the revapi configuration once a new version is released. Essentially, you can split extension blocks across multiple files, but the extension within the same pipeline must have the exact same ID. When they have the same ID, they will be merged. Revapi doesn't do complex merging, the merging is purely additive: this means scalar properties (e.g. boolean, string, int, etc.) will fail when specified multiple times. Collections are merged, however, so two arrays will be concatenated. We chose to use the extension name without the `revapi.` prefix, simply because it's shorter while remaining descriptive. This means all extensions share the same ID, and adding a new `ignored-changes.json` will also require one to do the same. I've updated [the wiki](https://github.com/camunda-cloud/zeebe/wiki/Breaking-Changes) as well to explain this. This will be necessary for #8837 since we will want to add some "breaking" changes (though they aren't ABI breaking). ## Related issues related to #8837 Co-authored-by: Nicolas Pepin-Perreault <nicolas.pepin-perreault@camunda.com>
|
Build failed: |
|
bors r+ |
ghost
pushed a commit
that referenced
this pull request
Mar 21, 2022
8936: Fixes revapi configuration for merging r=npepinpe a=npepinpe ## Description Fixes revapi configuration to allow merging configurations together. This will let us leverage the CI support for `ignored-changes.json` files, which are for temporary breaking changes which should be removed from the revapi configuration once a new version is released. Essentially, you can split extension blocks across multiple files, but the extension within the same pipeline must have the exact same ID. When they have the same ID, they will be merged. Revapi doesn't do complex merging, the merging is purely additive: this means scalar properties (e.g. boolean, string, int, etc.) will fail when specified multiple times. Collections are merged, however, so two arrays will be concatenated. We chose to use the extension name without the `revapi.` prefix, simply because it's shorter while remaining descriptive. This means all extensions share the same ID, and adding a new `ignored-changes.json` will also require one to do the same. I've updated [the wiki](https://github.com/camunda-cloud/zeebe/wiki/Breaking-Changes) as well to explain this. This will be necessary for #8837 since we will want to add some "breaking" changes (though they aren't ABI breaking). ## Related issues related to #8837 Co-authored-by: Nicolas Pepin-Perreault <nicolas.pepin-perreault@camunda.com>
|
Build failed: |
|
bors r+ 😄 |
ghost
pushed a commit
that referenced
this pull request
Mar 21, 2022
8936: Fixes revapi configuration for merging r=npepinpe a=npepinpe ## Description Fixes revapi configuration to allow merging configurations together. This will let us leverage the CI support for `ignored-changes.json` files, which are for temporary breaking changes which should be removed from the revapi configuration once a new version is released. Essentially, you can split extension blocks across multiple files, but the extension within the same pipeline must have the exact same ID. When they have the same ID, they will be merged. Revapi doesn't do complex merging, the merging is purely additive: this means scalar properties (e.g. boolean, string, int, etc.) will fail when specified multiple times. Collections are merged, however, so two arrays will be concatenated. We chose to use the extension name without the `revapi.` prefix, simply because it's shorter while remaining descriptive. This means all extensions share the same ID, and adding a new `ignored-changes.json` will also require one to do the same. I've updated [the wiki](https://github.com/camunda-cloud/zeebe/wiki/Breaking-Changes) as well to explain this. This will be necessary for #8837 since we will want to add some "breaking" changes (though they aren't ABI breaking). ## Related issues related to #8837 Co-authored-by: Nicolas Pepin-Perreault <nicolas.pepin-perreault@camunda.com>
|
Build failed: |
|
bors r+ |
ghost
pushed a commit
that referenced
this pull request
Mar 21, 2022
8936: Fixes revapi configuration for merging r=npepinpe a=npepinpe ## Description Fixes revapi configuration to allow merging configurations together. This will let us leverage the CI support for `ignored-changes.json` files, which are for temporary breaking changes which should be removed from the revapi configuration once a new version is released. Essentially, you can split extension blocks across multiple files, but the extension within the same pipeline must have the exact same ID. When they have the same ID, they will be merged. Revapi doesn't do complex merging, the merging is purely additive: this means scalar properties (e.g. boolean, string, int, etc.) will fail when specified multiple times. Collections are merged, however, so two arrays will be concatenated. We chose to use the extension name without the `revapi.` prefix, simply because it's shorter while remaining descriptive. This means all extensions share the same ID, and adding a new `ignored-changes.json` will also require one to do the same. I've updated [the wiki](https://github.com/camunda-cloud/zeebe/wiki/Breaking-Changes) as well to explain this. This will be necessary for #8837 since we will want to add some "breaking" changes (though they aren't ABI breaking). ## Related issues related to #8837 Co-authored-by: Nicolas Pepin-Perreault <nicolas.pepin-perreault@camunda.com>
|
Build failed: |
|
bors r+ 3 builds, 3 different failures 💪 |
ghost
pushed a commit
that referenced
this pull request
Mar 21, 2022
8936: Fixes revapi configuration for merging r=npepinpe a=npepinpe ## Description Fixes revapi configuration to allow merging configurations together. This will let us leverage the CI support for `ignored-changes.json` files, which are for temporary breaking changes which should be removed from the revapi configuration once a new version is released. Essentially, you can split extension blocks across multiple files, but the extension within the same pipeline must have the exact same ID. When they have the same ID, they will be merged. Revapi doesn't do complex merging, the merging is purely additive: this means scalar properties (e.g. boolean, string, int, etc.) will fail when specified multiple times. Collections are merged, however, so two arrays will be concatenated. We chose to use the extension name without the `revapi.` prefix, simply because it's shorter while remaining descriptive. This means all extensions share the same ID, and adding a new `ignored-changes.json` will also require one to do the same. I've updated [the wiki](https://github.com/camunda-cloud/zeebe/wiki/Breaking-Changes) as well to explain this. This will be necessary for #8837 since we will want to add some "breaking" changes (though they aren't ABI breaking). ## Related issues related to #8837 Co-authored-by: Nicolas Pepin-Perreault <nicolas.pepin-perreault@camunda.com>
|
Build failed: |
|
Beautiful 👌 Once bors finishes it's current PR, and if nothing is happening, then I'll just merge it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixes revapi configuration to allow merging configurations together. This will let us leverage the CI support for
ignored-changes.jsonfiles, which are for temporary breaking changes which should be removed from the revapi configuration once a new version is released.Essentially, you can split extension blocks across multiple files, but the extension within the same pipeline must have the exact same ID. When they have the same ID, they will be merged. Revapi doesn't do complex merging, the merging is purely additive: this means scalar properties (e.g. boolean, string, int, etc.) will fail when specified multiple times. Collections are merged, however, so two arrays will be concatenated.
We chose to use the extension name without the
revapi.prefix, simply because it's shorter while remaining descriptive. This means all extensions share the same ID, and adding a newignored-changes.jsonwill also require one to do the same. I've updated the wiki as well to explain this.This will be necessary for #8837 since we will want to add some "breaking" changes (though they aren't ABI breaking).
Related issues
related to #8837
Definition of Done
Not all items need to be done depending on the issue and the pull request.
Code changes:
backport stable/1.3) to the PR, in case that fails you need to create backports manually.Testing:
Documentation: