fix!: Make path a required config parameter#3872
Merged
kodiakhq[bot] merged 3 commits intomainfrom Nov 8, 2022
Merged
Conversation
erezrokah
approved these changes
Nov 8, 2022
kodiakhq bot
pushed a commit
that referenced
this pull request
Nov 8, 2022
🤖 I have created a release *beep* *boop* --- ## [2.0.0](cli-v1.5.9...cli-v2.0.0) (2022-11-08) ### ⚠ BREAKING CHANGES * Make path a required config parameter (#3872) ### Fixes * Make path a required config parameter ([#3872](#3872)) ([b0b4560](b0b4560)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
SCKelemen
pushed a commit
to SCKelemen/cloudquery
that referenced
this pull request
Nov 15, 2022
This SDK upgrade to the CLI adds the code in cloudquery/plugin-sdk#371, and as such will make `path` a required config parameter. We consider this a breaking change, so the CLI version will be bumped to 2.0.0. As context, we are making `path` required (and not inferred from `name`) because there has been some confusion around these settings. Previously `path` could have been inferred from `name` in some circumstances, but when using multiple configs, this was not always possible, causing confusion. From now on, `path` is a required parameter. It will usually take the form of `cloudquery/aws`, where `aws` is the source plugin name in this example. For the postgresql destination, it will be `cloudquery/postgresql`. - `name` should be thought of as the unique identifier of the particular source/destination config. It needs to be unique, as it will be used for overwriting stale entries in `overwrite-delete-stale` mode, inserted as a column alongside all entries, and ensure there are no race conditions when running multiple configs in parallel. - `path` is normally the unique path to download the plugin from. We have some special conventions around this, documented [here](https://www.cloudquery.io/docs/developers/creating-new-plugin#naming-conventions). It can also be used during development to point to a locally-running binary or GRPC server. Related: - cloudquery/plugin-sdk#317 - cloudquery/plugin-sdk#256
SCKelemen
pushed a commit
to SCKelemen/cloudquery
that referenced
this pull request
Nov 15, 2022
🤖 I have created a release *beep* *boop* --- ## [2.0.0](cloudquery/cloudquery@cli-v1.5.9...cli-v2.0.0) (2022-11-08) ### ⚠ BREAKING CHANGES * Make path a required config parameter (cloudquery#3872) ### Fixes * Make path a required config parameter ([cloudquery#3872](cloudquery#3872)) ([b0b4560](cloudquery@b0b4560)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This SDK upgrade to the CLI adds the code in cloudquery/plugin-sdk#371, and as such will make
patha required config parameter. We consider this a breaking change, so the CLI version will be bumped to 2.0.0.As context, we are making
pathrequired (and not inferred fromname) because there has been some confusion around these settings. Previouslypathcould have been inferred fromnamein some circumstances, but when using multiple configs, this was not always possible, causing confusion.From now on,
pathis a required parameter. It will usually take the form ofcloudquery/aws, whereawsis the source plugin name in this example. For the postgresql destination, it will becloudquery/postgresql.nameshould be thought of as the unique identifier of the particular source/destination config. It needs to be unique, as it will be used for overwriting stale entries inoverwrite-delete-stalemode, inserted as a column alongside all entries, and ensure there are no race conditions when running multiple configs in parallel.pathis normally the unique path to download the plugin from. We have some special conventions around this, documented here. It can also be used during development to point to a locally-running binary or GRPC server.Related:
idproperty instead of forcing a uniquenameplugin-sdk#317nameof the plugin plugin-sdk#256