This is the repository for the Azure-Repos source connector, written in Typescript. For information about how to use this connector within Airbyte, see the documentation.
To iterate on this connector, make sure to complete this prerequisites section.
From the root repository directory (NOT this folder), run:
npm i
This will install all required dependencies and build all included connectors, including the Azure-Repos source connector.
Now you can cd into the Azure-Repos connector directory, sources/azure-repos-source,
and iterate on the Azure-Repos source connector. After making code changes, run:
npm run build
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 repos, so there is
no danger of accidentally checking in sensitive information. See
test_files/config.json for a sample config file.
The Azure-Repos source connector requires the following permissions:
- vso.code,vso.profile,vso.project
| Name | Full | Incremental | Required Permissions |
|---|---|---|---|
| Commits | ✅ | ✅ | vso.code,vso.profile,vso.project |
| Pull Requests | ✅ | ✅ | vso.code,vso.profile,vso.project |
| Repositories | ✅ | vso.code,vso.profile,vso.project | |
| Users | ✅ | Cloud - vso.graph / Server - vso.profile,vso.project |
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
Go back to the root repository directory and run: First, make sure you build the latest Docker image:
docker build . --build-arg path=sources/azure-repos-source --build-arg version=0.0.1 -t azure-repos-source
Then return to the Azure-Repos connector directory and run any of the connector commands as follows:
docker run --rm azure-repos-source spec
docker run --rm -v $(pwd)/secrets:/secrets azure-repos-source check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets azure-repos-source discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/test_files:/test_files azure-repos-source read --config /secrets/config.json --catalog /test_files/full_configured_catalog.json
To run unit tests locally, from the Azure-Repos connector directory run:
npm test