Skip to content

Commit

Permalink
[local airbyte cdk tests] update README.md to fix gradle command and …
Browse files Browse the repository at this point in the history
…support more docker images (#20821)
  • Loading branch information
maxi297 authored Jan 3, 2023
1 parent d7f4f46 commit 7685f5a
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions airbyte-cdk/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,13 @@ Create a symlink that connects `<connector-directory>/airbyte-cdk` to your local
ln -s ../../../airbyte-cdk/python airbyte-cdk
```

Add the following lines to your connector's `Dockerfile`, before the line that installs dependencies via `pip install -e .`:
Now that you have a symbolic link in your source, you will nedd to install it in the docker image. Depending on how the docker image is build you will have two possibilities:
1. If image building process uses a temporary image called `builder`, add the following just after the copy of the installed packages to the folder `/usr/local`:
```Dockerfile
COPY airbyte-cdk airbyte-cdk
RUN PYTHONUSERBASE=/usr/local pip install -e ./airbyte-cdk
```
2. Add the following lines to your connector's `Dockerfile`, before the line that installs dependencies via `pip install -e .`:
```Dockerfile
COPY airbyte-cdk airbyte-cdk
RUN pip install -e ./airbyte-cdk
Expand All @@ -128,7 +134,7 @@ airbyteDocker {
You should be able to build your connector with
```bash
# from the airbytehq/airbyte base directory
./gradlew build :airbyte-integrations:connectors:<connector-directory>
./gradlew :airbyte-integrations:connectors:<connector-directory>:airbyteDocker
```
and the installation should use your local CDK. Note that the local CDK is injected at build time, so if you make changes, you will have to run the build command again to see them reflected.
**Note:** if your connector uses a `.dockerignore` file, it cannot have `exclude-all` or `exclude-except` patterns, i.e. the `.dockerignore` must specifically say which files to ignore without using any regex.
Expand Down

0 comments on commit 7685f5a

Please sign in to comment.