README.md

Airbyte Connectors

This repository contains Airbyte connectors used in Faros and Faros Community Edition platforms as well as Airbyte Connector Development Kit (CDK) for JavaScript/TypeScript.

See the READMEs inside destinations/ and sources/ subfolders for more information on each connector.

Component	Code	Installation	Version
Airbyte CDK for JavaScript/TypeScript	faros-airbyte-cdk	npm i faros-airbyte-cdk
Azure Active Directory Source	sources/azureactivedirectory-source	docker pull farosai/airbyte-azureactivedirectory-source
Azure Pipeline Source	sources/azurepipeline-source	docker pull farosai/airbyte-azurepipeline-source
Azure Repos Source	sources/azure-repos-source	docker pull farosai/airbyte-azure-repos-source
Azure Workitems Source	sources/azure-workitems-source	docker pull farosai/airbyte-azure-workitems-source
Backlog Source	sources/backlog-source	docker pull farosai/airbyte-backlog-source
Bitbucket Source	sources/bitbucket-source	docker pull farosai/airbyte-bitbucket-source
Bitbucket Server Source	sources/bitbucket-server-source	docker pull farosai/airbyte-bitbucket-server-source
Buildkite Source	sources/buildkite-source	docker pull farosai/airbyte-buildkite-source
Customer.IO Source	sources/customer-io-source	docker pull farosai/airbyte-customer-io-source
CircleCI Source	sources/circleci-source	docker pull farosai/airbyte-circleci-source
Datadog Source	sources/datadog-source	docker pull farosai/airbyte-datadog-source
Docker Source	sources/docker-source	docker pull farosai/airbyte-docker-source
Faros Destination	destinations/airbyte-faros-destination	npm i airbyte-faros-destination or docker pull farosai/airbyte-faros-destination
Faros GraphQL Source	sources/faros-graphql-source	docker pull farosai/airbyte-faros-graphql-source
Files Source	sources/files-source	docker pull farosai/airbyte-files-source
FireHydrant Source	sources/firehydrant-source	docker pull farosai/airbyte-firehydrant-source
Gitlab CI Source	sources/gitlab-ci-source	docker pull farosai/airbyte-gitlab-ci-source
Google Calendar Source	sources/googlecalendar-source	docker pull farosai/airbyte-googlecalendar-source
Harness Source	sources/harness-source	docker pull farosai/airbyte-harness-source
Jenkins Source	sources/jenkins-source	docker pull farosai/airbyte-jenkins-source
Jira Source	sources/jira-source	docker pull farosai/airbyte-jira-source
Okta Source	sources/okta-source	docker pull farosai/airbyte-okta-source
OpsGenie Source	sources/opsgenie-source	docker pull farosai/airbyte-opsgenie-source
PagerDuty Source	sources/pagerduty-source	docker pull farosai/airbyte-pagerduty-source
Phabricator Source	sources/phabricator-source	docker pull farosai/airbyte-phabricator-source
ServiceNow Source	sources/servicenow-source	docker pull farosai/airbyte-servicenow-source
Shortcut Source	sources/shortcut-source	docker pull farosai/airbyte-shortcut-source
SquadCast Source	sources/squadcast-source	docker pull farosai/airbyte-squadcast-source
StatusPage Source	sources/statuspage-source	docker pull farosai/airbyte-statuspage-source
Vanta Source	sources/vanta-source	docker pull farosai/airbyte-vanta-source
VictorOps Source	sources/victorops-source	docker pull farosai/airbyte-victorops-source
Workday Source	sources/workday-source	docker pull farosai/airbyte-workday-source

Development

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

👉 Follow our guide on how to develop a new source here.

Other Useful Commands

1. Audit fix npm audit fix
2. Clean your project npm run clean

Read more about lerna here.

Build Docker Images

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

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

And then run it:

docker run airbyte-faros-destination

Releasing

Create a new GitHub Release. The release workflow will automatically publish the packages to NPM and push Docker images to Docker Hub.