e65ecbd32c
Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
39 lines
1.4 KiB
Markdown
39 lines
1.4 KiB
Markdown
# Circleci
|
|
This directory contains the manifest-only connector for [`source-circleci`](https://app.circleci.com/).
|
|
|
|
## Documentation reference:
|
|
- Visit `https://circleci.com/docs/api/v1/index.html` for V1 API documentation
|
|
- Visit `https://circleci.com/docs/api/v2/index.html` for V2 API documentation
|
|
|
|
## Authentication setup
|
|
`CircleCI` uses api key authentication, Visit `https://app.circleci.com/settings/user/tokens` for getting your api keys.
|
|
|
|
## Usage
|
|
There are multiple ways to use this connector:
|
|
- You can use this connector as any other connector in Airbyte Marketplace.
|
|
- You can load this connector in `pyairbyte` using `get_source`!
|
|
- You can open this connector in Connector Builder, edit it, and publish to your workspaces.
|
|
|
|
Please refer to the manifest-only connector documentation for more details.
|
|
|
|
## Local Development
|
|
We recommend you use the Connector Builder to edit this connector.
|
|
|
|
But, if you want to develop this connector locally, you can use the following steps.
|
|
|
|
### Environment Setup
|
|
You will need `airbyte-ci` installed. You can find the documentation [here](airbyte-ci).
|
|
|
|
### Build
|
|
This will create a dev image (`source-circleci:dev`) that you can use to test the connector locally.
|
|
```bash
|
|
airbyte-ci connectors --name=source-circleci build
|
|
```
|
|
|
|
### Test
|
|
This will run the acceptance tests for the connector.
|
|
```bash
|
|
airbyte-ci connectors --name=source-circleci test
|
|
```
|
|
|