Skip to content

Commit ed216aa

Browse files
doc: update metadata documentation following CI change (#38558)
Co-authored-by: Ella Rohm-Ensing <[email protected]>
1 parent 4726263 commit ed216aa

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/connector-development/connector-metadata-file.md

+24
Original file line numberDiff line numberDiff line change
@@ -172,3 +172,27 @@ remoteRegistries:
172172
The `packageName` property of the `pypi` section is the name of the installable package in the PyPi registry.
173173

174174
If not specified, all remote registry configurations are disabled by default.
175+
176+
## The `connectorTestSuitesOptions` section
177+
178+
The `connectorTestSuitesOptions` contains a list of test suite options for a connector.
179+
The list of declared test suites affects which suite will run in CI.
180+
We currently accept three value for the `suite` field:
181+
* `unitTests`
182+
* `integrationTests`
183+
* `acceptanceTests`
184+
185+
Each list entry can also declare a `testSecrets` object which will enable our CI to fetch connector specific secret credentials which are required to run the `suite`.
186+
187+
### The `testSecrets` object
188+
The `testSecrets` object has three properties:
189+
* `name` (required `string`): The name of the secret in the secret store.
190+
* `secretStore` (required `secretStore` object): Where the secret is stored (more details on the object structure below).
191+
* `fileName` (optional `string`): The name of the file in which our CI will persist the secret (inside the connector's `secrets` directory).
192+
193+
**If you are a community contributor please note that addition of a new secret to our secret store requires manual intervention from an Airbyter. Please reach out to your PR reviewers if you want to add a test secret to our CI.**
194+
195+
#### The `secretStore` object
196+
This object has three properties:
197+
* `type`: Defines the secret store type, only `GSM` (Google Secret Manager) is currently supported
198+
* `alias`: The alias of this secret store in our system, which is resolved into an actual secret store address by our CI. We currently have a single alias to store our connector test secrets: `airbyte-connector-testing-secret-store` .

0 commit comments

Comments
 (0)