Airbyte Connectors

This repository contains Airbyte CDK and connectors implementations. See the READMEs inside destinations/ and sources/ subfolders for more information on each connector.

Component	Code	Installation	Version
Airbyte CDK	faros-airbyte-cdk	npm i faros-airbyte-cdk
Faros Destination	destinations/faros-destination	docker pull farosai/airbyte-faros-destination
Jenkins Source	sources/jenkins-source	docker pull farosai/airbyte-jenkins-source
Phabricator Source	sources/phabricator-source	docker pull farosai/airbyte-phabricator-source

Development

1. Install nvm
2. Install Node.js nvm install 14 && nvm use 14
3. Update npm to version 7.x by running npm install -g npm@7
4. Install lerna by running npm install -g lerna
5. Run npm run prepare to install dependencies for all projects (npm run clean to clean all)
6. Run npm run build to build all projects (for a single project add scope, e.g npm run build -- --scope faros-destination)
7. Run npm run test to test all projects (for a single project add scope, e.g npm run test -- --scope faros-destination)
8. Run npm run lint to apply linter on all projects (for a single project add scope, e.g npm run lint -- --scope faros-destination)

Other useful commands

1. Audit fix npm audit fix
2. Clean your project lerna run clean (sometimes you also wanna rm -rf ./node_modules)

Read more about lerna here - https://github.com/lerna/lerna

Build Docker images

In order to build a Docker image for a connector run the docker build command and set path argument. For example for Faros Destination connector run:

docker build . --build-arg path=destinations/faros-destination -t faros-destination

And then run it:

docker run faros-destination

Releasing

Publish CDK to NPM

To publish the CDK package to NPM, run npm run bump from the root of the repository. You will be prompted with a list of version increments to choose from (patch, minor, major, etc). Choose the desired increment, then commit and push the changed files. GitHub will automatically create a corresponding tag and publish the CDK to NPM once the changed files are merged to the main branch.

Publish Connector Docker images

Connector Docker images are automatically published to Docker Hub after updates to the main branch. They are tagged by the version listed in the connector's package.json. If the connector is updated without incrementing the version, GitHub will NOT overwrite the existing image in Docker Hub.