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

🐛 Source Close.com: extend roles schema with missing properties #25868

Merged
merged 7 commits into from
May 9, 2023

Conversation

bazarnov
Copy link
Collaborator

@bazarnov bazarnov commented May 6, 2023

What

Based on this CAT test: https://github.com/airbytehq/airbyte/actions/runs/4899393679
need to update the roles schema with missing and undocumented properties.

How

  • edited roles json schema with new properties:
"visibility_user_lcf_behavior": null,
"visibility_user_lcf_ids": []

These fields are not documented yet for Close.com, probably this is the silent API update. We will treat them as string.

  • added Airbyte CDK TypeTransformer to guarantee existing schema types
  • updated expected_records.jsonl with updated records

Recommended reading order

  1. x.java
  2. y.python

🚨 User Impact 🚨

No impact is expected, since this is Non-breaking change

For connector PRs, use this section to explain which type of semantic versioning bump occurs as a result of the changes. Refer to our Semantic Versioning for Connectors guidelines for more information. Breaking changes to connectors must be documented by an Airbyte engineer (PR author, or reviewer for community PRs) by using the Breaking Change Release Playbook.

If there are breaking changes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Actions

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • 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.
  • Connector version is set to 0.0.1
    • Dockerfile has version 0.0.1
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/integrations/<source or destination>/<name>.md including changelog with an entry for the initial version. See changelog example
    • docs/integrations/README.md

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.
Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Unit & integration tests added

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.
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

@github-actions
Copy link
Contributor

github-actions bot commented May 6, 2023

Before Merging a Connector Pull Request

Wow! What a great pull request you have here! 🎉

To merge this PR, ensure the following has been done/considered for each connector added or updated:

  • PR name follows PR naming conventions
  • Breaking changes are considered. If a Breaking Change is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan and you've followed all steps in the Breaking Changes Checklist
  • Connector version has been incremented in the Dockerfile and metadata.yaml according to our Semantic Versioning for Connectors guidelines
  • Secrets in the connector's spec are annotated with airbyte_secret
  • All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...)
  • Changelog updated in docs/integrations/<source or destination>/<name>.md with an entry for the new version. See changelog example
  • You, or an Airbyter, have run /test successfully on this PR - or on a non-forked branch
  • You, or an Airbyter, have run /publish successfully on this PR - or on a non-forked branch
  • You've updated the connector's metadata.yaml file (new!)
  • The Octavia bot updated the source_definitions.yaml or destination_definitions.yaml, or you ran processResources manually (deprecated)

If the checklist is complete, but the CI check is failing,

  1. Check for hidden checklists in your PR description

  2. Toggle the github label checklist-action-run on/off to re-run the checklist CI.

@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label May 6, 2023
@bazarnov
Copy link
Collaborator Author

bazarnov commented May 6, 2023

/test connector=connectors/source-close-com

🕑 connectors/source-close-com https://github.com/airbytehq/airbyte/actions/runs/4903540052
✅ connectors/source-close-com https://github.com/airbytehq/airbyte/actions/runs/4903540052
No Python unittests run

Build Passed

Test summary info:

=========================== short test summary info ============================
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/connector_acceptance_test/tests/test_core.py:100: The previous and actual specifications are identical.
================== 39 passed, 1 skipped in 301.29s (0:05:01) ===================

Copy link
Contributor

@bnchrch bnchrch left a comment

Choose a reason for hiding this comment

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

LGTM! 💎

@bazarnov
Copy link
Collaborator Author

bazarnov commented May 9, 2023

/publish connector=connectors/source-close-com

🕑 Publishing the following connectors:
connectors/source-close-com
https://github.com/airbytehq/airbyte/actions/runs/4922953428


Connector Version Did it publish? Were definitions generated?
connectors/source-close-com 0.2.2

if you have connectors that successfully published but failed definition generation, follow step 4 here ▶️

@bazarnov
Copy link
Collaborator Author

bazarnov commented May 9, 2023

/publish connector=connectors/source-close-com

🕑 Publishing the following connectors:
connectors/source-close-com
https://github.com/airbytehq/airbyte/actions/runs/4924584867


Connector Version Did it publish? Were definitions generated?
connectors/source-close-com 0.2.2

if you have connectors that successfully published but failed definition generation, follow step 4 here ▶️

@bazarnov bazarnov merged commit aa5a914 into master May 9, 2023
20 checks passed
@bazarnov bazarnov deleted the baz/source-close-com-fix-roles-schema branch May 9, 2023 10:54
marcosmarxm pushed a commit to natalia-miinto/airbyte that referenced this pull request Jun 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation connectors/source/close-com team/connectors-python
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

None yet

5 participants