Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update metadata documentation following CI change #38558

Merged
merged 2 commits into from
May 24, 2024
Merged

doc: update metadata documentation following CI change #38558

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2b9ce2
doc: update metadata documentation following CI change
alafanechere May 22, 2024
535f505
Update docs/connector-development/connector-metadata-file.md
alafanechere May 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/connector-development/connector-metadata-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,3 +172,27 @@ remoteRegistries:
The `packageName` property of the `pypi` section is the name of the installable package in the PyPi registry.

If not specified, all remote registry configurations are disabled by default.

## The `connectorTestSuitesOptions` section

The `connectorTestSuitesOptions` contains a list of test suite options for a connector.
The list of declared test suites affects which suite will run in CI.
We currently accept three value for the `suite` field:
* `unitTests`
* `integrationTests`
* `acceptanceTests`

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`.

### The `testSecrets` object
The `testSecrets` object has three properties:
* `name` (required `string`): The name of the secret in the secret store.
* `secretStore` (required `secretStore` object): Where the secret is stored (more details on the object structure below).
* `fileName` (optional `string`): The name of the file in which our CI will persist the secret (inside the connector's `secrets` directory).

**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.**

#### The `secretStore` object
This object has three properties:
* `type`: Defines the secret store type, only `GSM` (Google Secret Manager) is currently supported
* `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` .
Loading