You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/connector-development/config-based/overview.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
:warning: This framework is in alpha stage. Support is not in production and is available only to select users. :warning:
4
4
5
5
The goal of this document is to give enough technical specifics to understand how config-based connectors work.
6
-
When you're ready to start building a connector, you can start with [the tutorial](../../../config-based/tutorial/0-getting-started.md) or dive into the [reference documentation](https://airbyte-cdk.readthedocs.io/en/latest/api/airbyte_cdk.sources.declarative.html)
6
+
When you're ready to start building a connector, you can start with [the tutorial](./tutorial/0-getting-started.md) or dive into the [reference documentation](https://airbyte-cdk.readthedocs.io/en/latest/api/airbyte_cdk.sources.declarative.html)
Next, we'll add the connector to the [Airbyte platform](https://docs.airbyte.com/connector-development/tutorials/cdk-tutorial-python-http/use-connector-in-airbyte).
41
41
42
-
See your [Contributiong guide]() on how to get started releasing your connector.
42
+
See your [Contributiong guide](../../../contributing-to-airbyte/README.md) on how to get started releasing your connector.
Copy file name to clipboardExpand all lines: docs/contributing-to-airbyte/gradle-cheatsheet.md
+9-7Lines changed: 9 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -13,6 +13,7 @@ We have 3 ways of slicing our builds:
13
13
In our CI we run **Build Platform** and **Build Connectors Base**. Then separately, on a regular cadence, we build each connector and run its integration tests.
14
14
15
15
We split Build Platform and Build Connectors Base from each other for a few reasons:
16
+
16
17
1. The tech stacks are very different. The Platform is almost entirely Java. Because of differing needs around separating environments, the Platform build can be optimized separately from the Connectors one.
17
18
2. We want to the iteration cycles of people working on connectors or the platform faster _and_ independent. e.g. Before this change someone working on a Platform feature needs to run formatting on the entire codebase \(including connectors\). This led to a lot of cosmetic build failures that obfuscated actually problems. Ideally a failure on the connectors side should not block progress on the platform side.
18
19
3. The lifecycles are different. One can safely release the Platform even if parts of Connectors Base is failing \(and vice versa\).
@@ -101,18 +102,18 @@ We split Acceptance Tests into 2 different test suites:
101
102
* Platform Acceptance Tests: These tests are a coarse test to sanity check that each major feature in the platform. They are run with the following command: `SUB_BUILD=PLATFORM ./gradlew :airbyte-tests:acceptanceTests`. These tests expect to find a local version of Airbyte running. For testing the docker version start Airbyte locally. For an example, see the [acceptance_test script](../../tools/bin/acceptance_test.sh) that is used by the CI. For Kubernetes, see the [accetance_test_kube script](../../tools/bin/acceptance_test_kube.sh) that is used by the CI.
102
103
* Migration Acceptance Tests: These tests make sure the end-to-end process of migrating from one version of Airbyte to the next works. These tests are run with the following command: `SUB_BUILD=PLATFORM ./gradlew :airbyte-tests:automaticMigrationAcceptanceTest --scan`. These tests do not expect there to be a separate deployment of Airbyte running.
103
104
104
-
These tests currently all live in [airbyte-tests](../.././airbyte-tests)
105
+
These tests currently all live in [airbyte-tests](https://github.com/airbytehq/airbyte/airbyte-tests)
105
106
106
107
**Frontend Acceptance Tests**
107
108
108
-
These are acceptance tests for the frontend. They are run with
109
+
These are acceptance tests for the frontend. They are run with
Like the Platform Acceptance Tests, they expect Airbyte to be running locally. See the [script](https://github.com/airbytehq/airbyte/blob/master/tools/bin/e2e_test.sh) that is used by the CI.
113
113
114
+
Like the Platform Acceptance Tests, they expect Airbyte to be running locally. See the [script](https://github.com/airbytehq/airbyte/blob/master/tools/bin/e2e_test.sh) that is used by the CI.
114
115
115
-
These tests currently all live in [airbyte-webapp-e2e-tests](../.././airbyte-webapp-e2e-tests)
116
+
These tests currently all live in [airbyte-webapp-e2e-tests](https://github.com/airbytehq/airbyte/airbyte-webapp-e2e-tests)
116
117
117
118
**Future Work**
118
119
@@ -124,11 +125,12 @@ Our story around "integration testing" or "E2E testing" is a little ambiguous. O
124
125
125
126
All connectors, regardless of implementation language, implement the following interface to allow uniformity in the build system when run from CI:
126
127
127
-
**Build connector, run unit tests, and build Docker image**:
128
+
**Build connector, run unit tests, and build Docker image**:
0 commit comments