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

Feature/contact list api updates #156

Merged
merged 10 commits into from
Mar 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/deprecation-tracker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: ⚠️ Deprecation Tracker
description: Use this template to flag and track deprecated items (field, model, or functionality) scheduled for removal.
title: "[Deprecation] <Item Name>"
labels: ["type:deprecation"]
body:
- type: markdown
attributes:
value: |
Thank you for helping manage our deprecation process. This template is intended to track deprecated items and plan for their ultimate removal. Providing complete information below will help us ensure a smooth transition and keep our users informed.
- type: input
attributes:
label: Planned Removal Date
description: Enter the date when this deprecated item will be fully removed (format - "Month Day, Year". eg. "May 10th, 2025").
validations:
required: true
- type: input
attributes:
label: Original Deprecation Issue Link
description: Provide the link to the issue where the deprecation was initially proposed or discussed.
validations:
required: true
- type: input
attributes:
label: Original Deprecation PR Link
description: Provide the link to the pull request that implemented the deprecation.
validations:
required: true
- type: dropdown
attributes:
label: Deprecated Item Type
description: Select the type(s) of item(s) being deprecated.
options:
- Field
- Model
- Functionality
- Other
validations:
required: true
- type: input
attributes:
label: Deprecated Item
description: Specify the name(s) and any other relevant information of the deprecated item(s).
validations:
required: true
- type: textarea
attributes:
label: Rationale and Impact Analysis
description: |
Explain why this item is being deprecated and discuss any potential impacts.
validations:
required: true
- type: textarea
attributes:
label: Migration Path / Alternatives
description: |
Provide details on how users should transition away from this deprecated item, including any recommended alternatives.
validations:
required: false
- type: textarea
attributes:
label: Additional Context or Notes
description: |
Include any other relevant information or context that might be important for planning or executing the deprecation process.
validations:
required: false
36 changes: 36 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,39 @@
# dbt_hubspot v0.22.0

[PR #156](https://github.com/fivetran/dbt_hubspot/pull/156) includes the following updates:

## Deprecations
- Select fields have been deprecated from `hubspot__contact_lists` model as well as the upstream `stg_hubspot__contact_list` model (see HubSpot Source ([#137](https://github.com/fivetran/dbt_hubspot_source/pull/137)) for details). The full removal date is planned for May 10th, 2025. Follow [Deprecation Issue #138](https://github.com/fivetran/dbt_hubspot_source/issues/138) for more details and updates around the planned sunsetting of the fields.
- The deprecated fields include the following:
- `is_deletable`
- `is_dynamic`
- `metadata_error`
- `metadata_last_processing_state_change_at`
- `metadata_last_size_change_at`
- `metadata_processing`
- `metadata_size`
- `portal_id`

## Breaking Changes
- Select fields have been added to the `hubspot__contact_lists` model as well as the upstream `stg_hubspot__contact_list` model (see HubSpot Source ([#137](https://github.com/fivetran/dbt_hubspot_source/pull/137)) for details).
- The newly added fields include the following:
- `created_by_id`
- `object_type_id`
- `processing_status`
- `processing_type`
- `list_version`
- `filters_updated_at`

## Documentation
- All deprecated fields have been documented as notice of deprecation in the respective yml documents.
- All added fields have been documented.

## Under the Hood
- Added a deprecation tracker GitHub issue template to ensure deprecated fields are appropriately tracked for full removal in a future planned update.
- Added consistency validation tests to ensure the `hubspot__contact_lists` model remains consistent on subsequent updates.
- Included an integrity validation test to ensure the accuracy of the `hubspot__contact_lists` model.
- Updated the daily ticket integrity and consistency tests to be turned off if the `hubspot_service_enabled` variable is disabled.

# dbt_hubspot v0.21.0
This release includes the following updates:

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Include the following hubspot package version in your `packages.yml` file:
```yaml
packages:
- package: fivetran/hubspot
version: [">=0.21.0", "<0.22.0"] # we recommend using ranges to capture non-breaking changes automatically
version: [">=0.22.0", "<0.23.0"] # we recommend using ranges to capture non-breaking changes automatically

```
Do **NOT** include the `hubspot_source` package in this file. The transformation package itself has a dependency on it and will install the source package as well.
Expand Down Expand Up @@ -321,7 +321,7 @@ This dbt package is dependent on the following dbt packages. These dependencies
```yml
packages:
- package: fivetran/hubspot_source
version: [">=0.17.0", "<0.18.0"]
version: [">=0.18.0", "<0.19.0"]

- package: fivetran/fivetran_utils
version: [">=0.4.0", "<0.5.0"]
Expand Down
2 changes: 1 addition & 1 deletion dbt_project.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: 'hubspot'
version: '0.21.0'
version: '0.22.0'

config-version: 2
require-dbt-version: [">=1.3.0", "<2.0.0"]
Expand Down
2 changes: 1 addition & 1 deletion docs/catalog.json

Large diffs are not rendered by default.

47 changes: 37 additions & 10 deletions docs/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/manifest.json

Large diffs are not rendered by default.

16 changes: 9 additions & 7 deletions integration_tests/dbt_project.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: 'hubspot_integration_tests'
version: '0.21.0'
version: '0.22.0'

profile: 'integration_tests'
config-version: 2
Expand All @@ -10,11 +10,18 @@ models:

vars:
hubspot_schema: hubspot_integration_tests_63
consistency_test_contact_list_exclude_fields: ## For hubspot__contact_lists consistency test. Can be removed after this coming release.
- created_by_id
- object_type_id
- processing_status
- processing_type
- list_version
- filters_updated_at

# hubspot__pass_through_all_columns: true
# hubspot__company_pass_through_columns:
# - name: "property_hs_all-funky-a9384-syntax"
# alias: "funky_field"

# hubspot_service_enabled: true # enable when generating docs
# hubspot_deal_enabled: true # enable when generating docs
# hubspot_contact_enabled: true # enable when generating docs
Expand Down Expand Up @@ -200,11 +207,6 @@ seeds:
+enabled: "{{ true if target.type == 'postgres' else false }}"
email_event_dropped_data:
+enabled: "{{ true if target.type not in ('snowflake', 'postgres') else false }}"
contact_list_data:
+enabled: "{{ true if target.type != 'postgres' else false }}"
contact_list_data_postgres:
+alias: contact_list_data
+enabled: "{{ true if target.type == 'postgres' else false }}"
email_event_data:
+column_types:
_fivetran_synced: timestamp
Expand Down
Loading