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.

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

Davinchia/tracking client refactor #7595

Merged
merged 17 commits into from Nov 10, 2021
Merged

Conversation

davinchia
Copy link
Contributor

What

OSS piece of #7456 .

Basically documentation and some minor variable naming to make clear what is really happening here, with the goal being a dev should be able to read these and understand without really needing to ask someone else what is happening.

How

Docstrings!

Recommended reading order

The two files.

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/SUMMARY.md
    • 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
  • Connector added to connector index like described here

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
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command 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
  • Connector version bumped like described here

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
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub 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.

@davinchia davinchia temporarily deployed to more-secrets November 4, 2021 01:40 Inactive
@davinchia davinchia temporarily deployed to more-secrets November 10, 2021 11:01 Inactive
@davinchia davinchia temporarily deployed to more-secrets November 10, 2021 11:34 Inactive
@davinchia davinchia temporarily deployed to more-secrets November 10, 2021 11:36 Inactive
@davinchia davinchia temporarily deployed to more-secrets November 10, 2021 13:43 Inactive
@davinchia davinchia temporarily deployed to more-secrets November 10, 2021 13:52 Inactive
@davinchia davinchia temporarily deployed to more-secrets November 10, 2021 13:58 Inactive
@github-actions github-actions bot added the area/connectors Connector related issues label Nov 10, 2021
@davinchia davinchia temporarily deployed to more-secrets November 10, 2021 14:13 Inactive
@davinchia davinchia temporarily deployed to more-secrets November 10, 2021 14:24 Inactive
@davinchia davinchia temporarily deployed to more-secrets November 10, 2021 14:52 Inactive
@davinchia davinchia temporarily deployed to more-secrets November 10, 2021 15:13 Inactive
@davinchia davinchia merged commit 7f6d12a into master Nov 10, 2021
@davinchia davinchia deleted the davinchia/tracking-client-refactor branch November 10, 2021 16:21
schlattk pushed a commit to schlattk/airbyte that referenced this pull request Jan 4, 2022
* Add doc string to tracking interface.

* Add doc string with minor refactor.

* Update airbyte-analytics/src/main/java/io/airbyte/analytics/SegmentTrackingClient.java

* Format javadoc. Add user_id trait.

* Better formatting javadocs.

* Turn on spotless.

* Format before checking again.

* Clean this up.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants