Skip to content

chore(main): Release v1.0.4#371

Merged
kodiakhq[bot] merged 1 commit intomainfrom
release-please--branches--main--components--plugin-sdk
Nov 8, 2022
Merged

chore(main): Release v1.0.4#371
kodiakhq[bot] merged 1 commit intomainfrom
release-please--branches--main--components--plugin-sdk

Conversation

@cq-bot
Copy link
Copy Markdown
Contributor

@cq-bot cq-bot commented Nov 8, 2022

🤖 I have created a release beep boop

1.0.4 (2022-11-08)

Bug Fixes

  • Make path a required config parameter (#368) (77fdaf8)

This PR was generated with Release Please. See documentation.

@kodiakhq kodiakhq bot merged commit 6aaa6a9 into main Nov 8, 2022
@kodiakhq kodiakhq bot deleted the release-please--branches--main--components--plugin-sdk branch November 8, 2022 09:01
@cq-bot
Copy link
Copy Markdown
Contributor Author

cq-bot commented Nov 8, 2022

🤖 Release is at https://github.com/cloudquery/plugin-sdk/releases/tag/v1.0.4 🌻

kodiakhq bot pushed a commit to cloudquery/cloudquery that referenced this pull request Nov 8, 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
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
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.

2 participants