Skip to content

Latest commit

 

History

History
93 lines (64 loc) · 2.73 KB

README.md

File metadata and controls

93 lines (64 loc) · 2.73 KB
Raw

Backlog Source

This is the repository for the Backlog source connector, written in Typescript. For information about how to use this connector within Airbyte, see the documentation.

Local development

Prerequisites

To iterate on this connector, make sure to complete this prerequisites section.

Minimum Node.js version required = 14.5

Build connector

From the root repository directory (NOT this folder), run:

npm run prepare

This will install all required dependencies and build all included connectors, including the Backlog source connector.

Now you can cd into the Backlog connector directory, sources/backlog-source, and iterate on the Backlog source connector. After making code changes, run:

npm run build

Create credentials

Follow the instructions in the documentation to generate the necessary credentials. Then create a file secrets/config.json conforming to the resources/spec.json file. Note that any directory named secrets is gitignored across the entire airbyte-connectors repo, so there is no danger of accidentally checking in sensitive information. See test_files/config.json for a sample config file.

Locally running the connector

bin/main spec
bin/main check --config secrets/config.json
bin/main discover --config secrets/config.json
bin/main read --config secrets/config.json --catalog test_files/full_configured_catalog.json

Locally running the connector docker image

Build

Go back to the root repository directory and run: First, make sure you build the latest Docker image:

docker build . --build-arg path=sources/backlog-source --build-arg version=0.0.1 -t backlog-source

Run

Then return to the Backlog connector directory and run any of the connector commands as follows:

docker run --rm backlog-source spec
docker run --rm -v $(pwd)/secrets:/secrets backlog-source check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets backlog-source discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/test_files:/test_files backlog-source read --config /secrets/config.json --catalog /test_files/full_configured_catalog.json

Testing

Unit Tests

To run unit tests locally, from the Backlog connector directory run:

npm test

Dependency Management

We use lerna to manage dependencies that are shared by all connectors in this repository. Dependencies specific to this connector should go in the connector's package.json. Dependencies shared by all connectors, such as linting/formatting tools, should go in the root package.json.