Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update misleading fields in config-based connector template #15424

Merged
merged 5 commits into from
Aug 9, 2022
Merged

Update misleading fields in config-based connector template #15424

merged 5 commits into from
Aug 9, 2022

Conversation

girarda
Copy link
Contributor

@girarda girarda commented Aug 9, 2022 •
edited
Loading

What

Few updates to the configuration-based connector template to make it more valuable.

  1. Update stream_names to the stream's name (this is a bug)
  2. Change the default authenticator to BearerAuthenticator because it's a better default (simpler and frequently used)

How

  • Update the default authenticator to BearerAuthenticator
  • Update the streams_namefield to point to the stream's name
  • Bump minimum cdk version to include recent bug fixes

Recommended reading order

  1. airbyte-integrations/connector-templates/source-configuration-based/source_{{snakeCase name}}/{{snakeCase name}}.yaml.hbs
  2. airbyte-integrations/connector-templates/source-configuration-based/setup.py.hbs

🚨 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

  • Community member? 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
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • 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 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 and connector version bumped by running the /publish command 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.

girarda
girarda commented Aug 9, 2022
View reviewed changes
airbyte-integrations/connector-templates/source-configuration-based/setup.py.hbs Outdated
@@ -6,7 +6,7 @@
from setuptools import find_packages, setup

MAIN_REQUIREMENTS = [
"airbyte-cdk~=0.1.68",
"airbyte-cdk~=0.1.71",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bump to latest version to include bug fixes

girarda
girarda commented Aug 9, 2022
View reviewed changes
...r-templates/source-configuration-based/source_{{snakeCase name}}/{{snakeCase name}}.yaml.hbs
@@ -11,7 +11,7 @@ requester:
name: "\{{ options['name'] }}"
http_method: "GET"
authenticator:
type: ApiKeyAuthenticator
type: BearerAuthenticator
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BearerAuthenticator is probably a better default because it is simpler and very common

girarda
girarda commented Aug 9, 2022
View reviewed changes
...r-templates/source-configuration-based/source_{{snakeCase name}}/{{snakeCase name}}.yaml.hbs
@@ -39,4 +39,4 @@ streams:
- "*ref(customers_stream)"
check:
type: CheckStream
stream_names: ["customers_stream"]
stream_names: ["customers"]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this needs to be the name

@girarda girarda changed the title Fix template Update misleading fields in config-based connector template Aug 9, 2022
@girarda girarda requested a review from brianjlai August 9, 2022 01:45
@girarda girarda marked this pull request as ready for review August 9, 2022 01:45
@girarda girarda requested a review from a team as a code owner August 9, 2022 01:45
@girarda girarda merged commit 558c50c into master Aug 9, 2022
@girarda girarda deleted the alex/updateGeneratorTemplate branch August 9, 2022 02:04
@octavia-squidington-iii octavia-squidington-iii mentioned this pull request Aug 10, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sherifnada sherifnada sherifnada approved these changes

@brianjlai brianjlai Awaiting requested review from brianjlai

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@girarda @sherifnada