This is the repository for the Yellowbrick destination connector in Java. For information about how to use this connector within Airbyte, see the User Documentation.
From the Airbyte repository root, run:
./gradlew :airbyte-integrations:connectors:destination-yellowbrick:build
If you are a community contributor, generate the necessary credentials and place them in secrets/config.json
conforming to the spec file in src/main/resources/spec.json
.
Note that the secrets
directory is git-ignored by default, so there is no danger of accidentally checking in sensitive information.
If you are an Airbyte core member, follow the instructions to set up the credentials.
Build the connector image via Gradle:
./gradlew :airbyte-integrations:connectors:destination-yellowbrick:airbyteDocker
When building via Gradle, the docker image name and tag, respectively, are the values of the io.airbyte.name
and io.airbyte.version
LABEL
s in
the Dockerfile.
Then run any of the connector commands as follows:
docker run --rm airbyte/destination-yellowbrick:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/destination-yellowbrick:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/destination-yellowbrick:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/destination-yellowbrick:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
We use JUnit
for Java tests.
Place unit tests under src/test/io/airbyte/integrations/destinations/yellowbrick
.
Airbyte has a standard test suite that all destination connectors must pass. Implement the TODO
s in
src/test-integration/java/io/airbyte/integrations/destinations/yellowbrickDestinationAcceptanceTest.java
.
All commands should be run from airbyte project root. To run unit tests:
./gradlew :airbyte-integrations:connectors:destination-yellowbrick:unitTest
To run acceptance and custom integration tests:
./gradlew :airbyte-integrations:connectors:destination-yellowbrick:integrationTest
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
- Make sure your changes are passing unit and integration tests.
- Bump the connector version in
Dockerfile
-- just increment the value of theLABEL io.airbyte.version
appropriately (we use SemVer). - Create a Pull Request.
- Pat yourself on the back for being an awesome contributor.
- Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.