Split connector builds. #11148

davinchia · 2022-03-15T07:21:18Z

What

Follow up to #11064 for the connector builds. After this change, connector builds will only trigger if

there are changes in the airbyte-integration folder
there are changes in the airbyte-db folder

How

Add a new filter for connectors and add an if condition to the start connector base builder action.
Also take the chance to update the backend filter to be more accurate.

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user? If yes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

Create a non-forked branch based on this PR and test the below items on it
Build is successful
If new credentials are required for use in CI, add them to GSM. Instructions.
/test connector=connectors/<name> command is passing
New Connector version released on Dockerhub by running the /publish command described here
After the connector is published, connector added to connector index as described here
Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Updating a connector

Community member or Airbyter

Grant edit access to maintainers (instructions)
Secrets in the connector's spec are annotated with airbyte_secret
Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
Code reviews completed
Documentation updated
- Connector's README.md
- Connector's bootstrap.md. See description and examples
- Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

Create a non-forked branch based on this PR and test the below items on it
Build is successful
If new credentials are required for use in CI, add them to GSM. Instructions.
/test connector=connectors/<name> command is passing
New Connector version released on Dockerhub by running the /publish command described here
After the new connector version is published, connector version bumped in the seed directory as described here
Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Connector Generator

Issue acceptance criteria met
PR name follows PR naming conventions
If adding a new generator, add it to the list of scaffold modules being tested
The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
Documentation which references the generator is updated as needed

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

davinchia · 2022-03-15T07:25:53Z

Example of the connector build not running since there are no changes: https://github.com/airbytehq/airbyte/runs/5549783444?check_suite_focus=true

I removed the build condition to test this.

davinchia · 2022-03-15T07:32:53Z

Example of the connector build running because of changes in the db module: https://github.com/airbytehq/airbyte/runs/5549837857?check_suite_focus=true

davinchia · 2022-03-15T07:35:18Z

Example of connector build running because of changes in the integrations module: https://github.com/airbytehq/airbyte/runs/5549882923?check_suite_focus=true

…ne of the submodules.

davinchia · 2022-03-15T07:38:43Z

Example of connector build running because of change in connector submodule: https://github.com/airbytehq/airbyte/runs/5549907212?check_suite_focus=true

davinchia · 2022-03-15T07:39:14Z

.github/workflows/gradle.yml

@@ -39,8 +41,14 @@ jobs:
              - 'airbyte-**/**'
            build:
              - '.github/**'
+              - 'buildSrc/**'


I realised these are part of the 'build' too.

…should run if it is a backend change alongside the connector change.

…ting.

davinchia · 2022-03-15T09:58:48Z

.github/workflows/gradle.yml

          filters: |
            backend:
-              - 'airbyte-**/**'
+              - 'airbyte-!(integrations|webapp|webapp-e2e-tests)/**'


@cgardens I've improved the backend filter so it ignores the non-backend modules. This should further reduce excessive FE build runs. Lmk if I missed something out.

It feels like the right way to do this would be to use actual build caching in gradle instead of setting these manual filters. Not for this PR but is that the right North Star?

Yes. We do use gradle's caching under the hood. These filters happen at the build-infrastructure level instead of the build level. It helps us avoid running the same gradle tasks X many times on the various build pipelines.

We can try to push this into gradle (though honestly not much more we can do). However that still does not give teams build setup isolation from each other.

davinchia · 2022-03-15T09:59:09Z

.github/workflows/gradle.yml

@@ -504,7 +520,9 @@ jobs:
  start-frontend-test-runner:
    name: Start Frontend Test EC2 Runner
    needs: changes
-    if: needs.changes.outputs.frontend == 'true' || needs.changes.outputs.build == 'true' || needs.changes.outputs.backend == 'true' || github.ref == 'refs/heads/master'
+    if: |
+      needs.changes.outputs.frontend == 'true' || needs.changes.outputs.build == 'true' || github.ref == 'refs/heads/master'


splitting this for better formatting

davinchia · 2022-03-15T10:00:27Z

.github/workflows/gradle.yml

  start-connectors-base-build-runner:
    name: "Connectors Base: Start Build EC2 Runner"
+    needs: changes
+    if: |
+      needs.changes.outputs.build == 'true' || needs.changes.outputs.connectors == 'true' || needs.changes.outputs.db == 'true'


my understanding is the top level db module is the only module we want to rest the connector build on if it's changes. is this correct?

davinchia · 2022-03-15T10:06:51Z

PTAL @sherifnada @cgardens @jrhizor @supertopher following the previous split mechanism for the connector builds.

I think the DB module is the top level module we should trigger the connector build on - lmk if I missed something out.

FYI @timroes since this does touch the frontend build too.

This PT prevents connector build triggering on platform changes but does not prevent platform build triggering on connector changes. That will be the last follow up. I'm doing this piecemeal to minimise the changeset.

Follow up to #11148 and #11148 . Here we configure it so that platform builds only run on platform changes. As always, the build will run on build and github changes.

Add filtering for connector build.

119dc53

davinchia temporarily deployed to more-secrets March 15, 2022 07:21 Inactive

davinchia temporarily deployed to more-secrets March 15, 2022 07:22 Inactive

davinchia added 2 commits March 15, 2022 15:22

Remove build condition so we can test the new conditions.

d2035c1

Add stub db modifications.

8e66294

davinchia temporarily deployed to more-secrets March 15, 2022 07:26 Inactive

Remember to add outputs.

8ff44a8

davinchia temporarily deployed to more-secrets March 15, 2022 07:30 Inactive

davinchia temporarily deployed to more-secrets March 15, 2022 07:31 Inactive

Remove the test db file. Add a test connector change file.

8922b97

Remove test file in top level integrations folder. Add test file in o…

58487bb

…ne of the submodules.

davinchia temporarily deployed to more-secrets March 15, 2022 07:37 Inactive

Remove submodule testing file.

6e61884

davinchia temporarily deployed to more-secrets March 15, 2022 07:38 Inactive

davinchia commented Mar 15, 2022

View reviewed changes

davinchia added 6 commits March 15, 2022 15:48

The frontend build should not run if its only a connector change. It …

d4bc499

…should run if it is a backend change alongside the connector change.

Add proper filter for backend modules. Uncomment build for faster tes…

a416489

…ting.

Is the comment messing this up?

04e3cc5

Test airbyte-integrations correct filter.

6960a04

Test airbyte-webappcorrect filter.

ae0b1fa

Test airbyte-webappcorrect filter.

2d22f45

github-actions bot added area/frontend area/platform issues related to the platform labels Mar 15, 2022

davinchia added 2 commits March 15, 2022 17:55

Uncomment rest of build.

11d673d

Remove test files.

4d96903

github-actions bot removed area/platform issues related to the platform area/frontend labels Mar 15, 2022

Better formatting.

d83d9ed

davinchia commented Mar 15, 2022

View reviewed changes

Split for better formatting.

300b0ef

davinchia commented Mar 15, 2022

View reviewed changes

davinchia marked this pull request as ready for review March 15, 2022 10:01

davinchia requested review from cgardens, jrhizor, supertopher and sherifnada March 15, 2022 10:03

davinchia mentioned this pull request Mar 15, 2022

Split OSS builds. #11156

Closed

davinchia merged commit 4c44e82 into master Mar 16, 2022

davinchia deleted the davinchia/split-connector-builds branch March 16, 2022 09:06

davinchia mentioned this pull request Mar 16, 2022

Split out Platform builds. #11188

Merged

40 tasks

davinchia added a commit that referenced this pull request Mar 16, 2022

Split out Platform builds. (#11188)

6b243fe

Follow up to #11148 and #11148 . Here we configure it so that platform builds only run on platform changes. As always, the build will run on build and github changes.

davinchia mentioned this pull request Jul 5, 2022

Improve Build Times #621

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Split connector builds. #11148

Split connector builds. #11148

davinchia commented Mar 15, 2022 •

edited

Loading

davinchia commented Mar 15, 2022

davinchia commented Mar 15, 2022

davinchia commented Mar 15, 2022

davinchia commented Mar 15, 2022

davinchia Mar 15, 2022

davinchia Mar 15, 2022 •

edited

Loading

sherifnada Mar 15, 2022

davinchia Mar 15, 2022 •

edited

Loading

davinchia Mar 15, 2022

davinchia Mar 15, 2022

davinchia commented Mar 15, 2022 •

edited

Loading

Split connector builds. #11148

Split connector builds. #11148

Conversation

davinchia commented Mar 15, 2022 • edited Loading

What

How

Recommended reading order

🚨 User Impact 🚨

Pre-merge Checklist

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

Tests

davinchia commented Mar 15, 2022

davinchia commented Mar 15, 2022

davinchia commented Mar 15, 2022

davinchia commented Mar 15, 2022

davinchia Mar 15, 2022

Choose a reason for hiding this comment

davinchia Mar 15, 2022 • edited Loading

Choose a reason for hiding this comment

sherifnada Mar 15, 2022

Choose a reason for hiding this comment

davinchia Mar 15, 2022 • edited Loading

Choose a reason for hiding this comment

davinchia Mar 15, 2022

Choose a reason for hiding this comment

davinchia Mar 15, 2022

Choose a reason for hiding this comment

davinchia commented Mar 15, 2022 • edited Loading

davinchia commented Mar 15, 2022 •

edited

Loading

davinchia Mar 15, 2022 •

edited

Loading

davinchia Mar 15, 2022 •

edited

Loading

davinchia commented Mar 15, 2022 •

edited

Loading