Skip to content

Commit

Permalink
source-productboard contribution from pabloescoder (#45449)
Browse files Browse the repository at this point in the history
Co-authored-by: Octavia Squidington III <[email protected]>
  • Loading branch information
pabloescoder and octavia-squidington-iii authored Sep 13, 2024
1 parent 58d241d commit 228ea14
Show file tree
Hide file tree
Showing 6 changed files with 2,036 additions and 0 deletions.
39 changes: 39 additions & 0 deletions airbyte-integrations/connectors/source-productboard/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Productboard
This directory contains the manifest-only connector for `source-productboard`.
https://www.productboard.com/

## Documentation reference:
Visit https://developer.productboard.com/reference/ for API documentation

## Authentication setup
`source-productboard` uses API Token authentication.
Visit https://developer.productboard.com/reference/authentication#public-api-access-token for steps to generate an access token.

## 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](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md).

### Build
This will create a dev image (`source-productboard:dev`) that you can use to test the connector locally.
```bash
airbyte-ci connectors --name=source-productboard build
```

### Test
This will run the acceptance tests for the connector.
```bash
airbyte-ci connectors --name=source-productboard test
```

Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference)
# for more information about how to configure these tests
connector_image: airbyte/source-productboard:dev
acceptance_tests:
spec:
tests:
- spec_path: "manifest.yaml"
connection:
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
discovery:
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
basic_read:
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
incremental:
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
full_refresh:
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
8 changes: 8 additions & 0 deletions airbyte-integrations/connectors/source-productboard/icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 228ea14

Please sign in to comment.