-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Source lemlist: Migrate to manifest-only (#44413)
- Loading branch information
1 parent
2a2454c
commit 645eb33
Showing
13 changed files
with
1,158 additions
and
1,909 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,78 +1,65 @@ | ||
# Lemlist Source | ||
# Lemlist source connector | ||
|
||
This is the repository for the Lemlist configuration based source connector. | ||
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/lemlist). | ||
This directory contains the manifest-only connector for `source-lemlist`. | ||
This _manifest-only_ connector is not a Python package on its own, as it runs inside of the base `source-declarative-manifest` image. | ||
|
||
## Local development | ||
For information about how to configure and use this connector within Airbyte, see [the connector's full documentation](https://docs.airbyte.com/integrations/sources/lemlist). | ||
|
||
#### Create credentials | ||
## Local development | ||
|
||
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/lemlist) | ||
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_lemlist/spec.yaml` file. | ||
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information. | ||
See `integration_tests/sample_config.json` for a sample config file. | ||
We recommend using the Connector Builder to edit this connector. | ||
Using either Airbyte Cloud or your local Airbyte OSS instance, navigate to the **Builder** tab and select **Import a YAML**. | ||
Then select the connector's `manifest.yaml` file to load the connector into the Builder. You're now ready to make changes to the connector! | ||
|
||
**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source lemlist test creds` | ||
and place them into `secrets/config.json`. | ||
If you prefer to develop locally, you can follow the instructions below. | ||
|
||
### Locally running the connector docker image | ||
### Building the docker image | ||
|
||
#### Build | ||
You can build any manifest-only connector with `airbyte-ci`: | ||
|
||
**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):** | ||
1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) | ||
2. Run the following command to build the docker image: | ||
|
||
```bash | ||
airbyte-ci connectors --name=source-lemlist build | ||
``` | ||
|
||
An image will be built with the tag `airbyte/source-lemlist:dev`. | ||
An image will be available on your host with the tag `airbyte/source-lemlist:dev`. | ||
|
||
**Via `docker build`:** | ||
### Creating credentials | ||
|
||
```bash | ||
docker build -t airbyte/source-lemlist:dev . | ||
``` | ||
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/lemlist) | ||
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `spec` object in the connector's `manifest.yaml` file. | ||
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information. | ||
|
||
#### Run | ||
### Running as a docker container | ||
|
||
Then run any of the connector commands as follows: | ||
Then run any of the standard source connector commands: | ||
|
||
``` | ||
```bash | ||
docker run --rm airbyte/source-lemlist:dev spec | ||
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-lemlist:dev check --config /secrets/config.json | ||
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-lemlist:dev discover --config /secrets/config.json | ||
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-lemlist:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json | ||
``` | ||
|
||
## Testing | ||
### Running the CI test suite | ||
|
||
You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md): | ||
|
||
```bash | ||
airbyte-ci connectors --name=source-lemlist test | ||
``` | ||
|
||
### Customizing acceptance Tests | ||
|
||
Customize `acceptance-test-config.yml` file to configure tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information. | ||
If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py. | ||
|
||
## Dependency Management | ||
|
||
All of your dependencies should go in `setup.py`, NOT `requirements.txt`. The requirements file is only used to connect internal Airbyte dependencies in the monorepo for local development. | ||
We split dependencies between two groups, dependencies that are: | ||
|
||
- required for your connector to work need to go to `MAIN_REQUIREMENTS` list. | ||
- required for the testing need to go to `TEST_REQUIREMENTS` list | ||
|
||
### Publishing a new version of the connector | ||
|
||
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what? | ||
## Publishing a new version of the connector | ||
|
||
1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-lemlist test` | ||
2. Bump the connector version in `metadata.yaml`: increment the `dockerImageTag` value. Please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors). | ||
3. Make sure the `metadata.yaml` content is up to date. | ||
4. Make the connector documentation and its changelog is up to date (`docs/integrations/sources/lemlist.md`). | ||
If you want to contribute changes to `source-lemlist`, here's how you can do that: | ||
1. Make your changes locally, or load the connector's manifest into Connector Builder and make changes there. | ||
2. Make sure your changes are passing our test suite with `airbyte-ci connectors --name=source-lemlist test` | ||
3. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)): | ||
- bump the `dockerImageTag` value in in `metadata.yaml` | ||
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/lemlist.md`). | ||
5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention). | ||
6. Pat yourself on the back for being an awesome contributor. | ||
7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master. | ||
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry. |
This file was deleted.
Oops, something went wrong.
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
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.