release/v0.21.0

.github/PULL_REQUEST_TEMPLATE/maintainer_pull_request_template.md

@@ -1,29 +1,38 @@
-## PR Overview
-**This PR will address the following Issue/Feature:**
+<!--
+Pre-Submission Reminders  
+Before marking this PR as "ready for review":
 
-**This PR will result in the following new package version:**
-<!--- Please add details around your decision for breaking vs non-breaking version upgrade. If this is a breaking change, were backwards-compatible options explored? -->
+- `dbt run --full-refresh && dbt test`  
+- `dbt run` && `dbt test` (if incremental models are present)  
+- The related issue is linked, tagged, and appropriately assigned  
+- Documentation and version updates are included, if applicable  
+- `docs` have been regenerated (unless there are no code or YAML changes)  
+- BuildKite integration tests are passing
+-->
 
-**Please provide the finalized CHANGELOG entry which details the relevant changes included in this PR:**
-<!--- Copy/paste the CHANGELOG for this version below. -->
+## PR Overview 
+**Package version introduced in this PR:** 
+- 
 
-## PR Checklist
-### Basic Validation
-Please acknowledge that you have successfully performed the following commands locally:
-- [ ] dbt run –full-refresh && dbt test
-- [ ] dbt run (if incremental models are present) && dbt test
+**This PR addresses the following Issue/Feature(s):**
+<!-- Add Issue # or internal ticket reference -->
+- 
 
-Before marking this PR as "ready for review" the following have been applied:
-- [ ] The appropriate issue has been linked, tagged, and properly assigned
-- [ ] All necessary documentation and version upgrades have been applied
-- [ ] docs were regenerated (unless this PR does not include any code or yml updates)
-- [ ] BuildKite integration tests are passing
-- [ ] Detailed validation steps have been provided below
+**Summary of changes:**  
+<!-- 1-2 sentences describing PR changes. -->
+- 
 
-### Detailed Validation
-Please share any and all of your validation steps:
-<!--- Provide the steps you took to validate your changes below. -->
+### Submission Checklist  
+- [ ] Alignment meeting with the reviewer (if needed)  
+  - [ ] Timeline and validation requirements discussed  
+- [ ] Provide validation details:  
+  - [ ] **Validation Steps:** Check for unintentional effects (e.g., add/run consistency & integrity tests)
+  - [ ] **Testing Instructions:** Confirm the change addresses the issue(s)
+  - [ ] **Focus Areas:** Complex logic or queries that need extra attention  
+- [ ] Merge any relevant open PRs into this PR
 
-### If you had to summarize this PR in an emoji, which would it be?
-<!--- For a complete list of markdown compatible emojis check our this git repo (https://gist.github.com/rxaviers/7360908)  --> 
-:dancer:
+### Changelog  
+<!-- Recommend drafting changelog notes, then refining via ChatGPT using:  
+"Draft a changelog entry based on the following notes." -->
+- [ ] Draft changelog for PR  
+- [ ] Final changelog for release review

.github/workflows/auto-release.yml

@@ -3,11 +3,12 @@ on:
   pull_request:
     types:
       - closed
-    branches:
-      - main
+      - labeled
 
 jobs:
-  call-workflow-passing-data:
-    if: github.event.pull_request.merged
+  release:
+    if: |
+      (github.event.pull_request.merged == true && github.event.pull_request.base.ref == 'main') ||
+      github.event.label.name == 'pre-release'
     uses: fivetran/dbt_package_automations/.github/workflows/auto-release.yml@main
-    secrets: inherit
+    secrets: inherit

.github/workflows/generate-docs.yml

@@ -0,0 +1,13 @@
+name: 'generate dbt docs'
+on:
+  pull_request:
+    types:
+      - labeled
+
+jobs:
+  generate-docs:
+    if: github.event.label.name == 'docs:ready'
+    uses: fivetran/dbt_package_automations/.github/workflows/generate-docs.yml@main
+    secrets: inherit
+    with:
+      schema_var_name: hubspot_schema

.gitignore

@@ -1,7 +1,73 @@
-
-target/
+# dbt
+**/package-lock.yml
+package-lock.yml
+.dbt/
 dbt_modules/
+dbt_packages/
 logs/
+profiles.yml
+target/
+*.log
+
+# IDE files
+.idea/
+.vscode/
+*~
+*.swp
+*.swo
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# OS generated files
+**/.DS_Store
 .DS_Store
-dbt_packages/
-env/
+.Spotlight-V100
+.Trashes
+._*
+Thumbs.db
+ehthumbs.db
+
+# Python
+*.egg
+*.egg-info/
+*.py[cod]
+*.so
+*$py.class
+.Python
+__pycache__/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.env
+.installed.cfg
+lib/
+lib64/
+MANIFEST
+parts/
+sdist/
+var/
+wheels/
+
+# Secrets and credentials
+.env.*
+.secrets
+credentials.json
+service-account.json
+
+# Temporary files
+.cache/
+*.temp
+*.tmp
+
+# Virtual environments
+.conda/
+.env
+.venv
+ENV/
+env/
+env.bak/
+venv/
+venv.bak/

CHANGELOG.md

@@ -1,3 +1,28 @@
+# dbt_hubspot_source v0.21.0
+
+[PR #146](https://github.com/fivetran/dbt_hubspot_source/pull/146) includes the
+following updates:
+
+## Schema Changes 
+**1 total change • 1 possible breaking change**
+| **Model** | **Change type** | **Old name** | **New name** | **Notes** |
+|-----------|----------------|--------------|--------------|---------|
+| [stg_hubspot__deal_pipeline_stage](https://fivetran.github.io/dbt_hubspot_source/#!/model/model.hubspot_source.stg_hubspot__deal_pipeline_stage) | Column Renamed | `is_closed_won` | `is_closed` | Column renamed to more accurately match the source data. The renamed `is_closed` column is generated via a coalesce between the previous `closed_won` source column and the newly added `is_closed` column. This renamed column represents whether a deal is closed, regardless of its label as “Closed Won” or “Closed Lost.” You can still use the `pipeline_stage_label` column to differentiate between "Closed Won" and "Closed Lost" stages. |
+
+## Under the Hood
+- Documented the column updates and deprecations in the respective yml files. 
+- Updated the `deal_pipeline_stage_data` seed to include the `is_closed` column. 
+- Introduced the generate-docs github workflow for consistent docs generation. 
+- Updated the maintainer pull request template. 
+- Updated conditions in `.github/workflows/auto-release.yml`. 
+- Added `.github/workflows/generate-docs.yml`. 
+- Added `+docs: show: False` to `integration_tests/dbt_project.yml`. 
+- Migrated `flags` (e.g., `send_anonymous_usage_stats`, `use_colors`) from `sample.profiles.yml` to `integration_tests/dbt_project.yml`. 
+- Updated `maintainer_pull_request_template.md` with improved checklist. 
+- Refreshed README tag block:
+  - Left-aligned and positioned below the H1 title. 
+- Updated `.gitignore` to exclude additional DBT, Python, and system artifacts.
+
 # dbt_hubspot_source v0.20.0
 
 [PR #144](https://github.com/fivetran/dbt_hubspot_source/pull/144) includes the following updates:

README.md

@@ -4,14 +4,12 @@
     <a alt="License"
         href="https://github.com/fivetran/dbt_hubspot_source/blob/main/LICENSE">
         <img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" /></a>
-    <img src="https://img.shields.io/badge/dbt_Core™_version->=1.3.0_,<2.0.0-orange.svg" /></a>
+    <a alt="dbt-core">
+        <img src="https://img.shields.io/badge/dbt_Core™_version->=1.3.0_,<2.0.0-orange.svg" /></a>
     <a alt="Maintained?">
         <img src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" /></a>
     <a alt="PRs">
         <img src="https://img.shields.io/badge/Contributions-welcome-blueviolet" /></a>
-    <a alt="Fivetran Quickstart Compatible"
-        href="https://fivetran.com/docs/transformations/dbt/quickstart">
-        <img src="https://img.shields.io/badge/Fivetran_Quickstart_Compatible%3F-yes-green.svg" /></a>
 </p>
 
 ## What does this dbt package do?
@@ -44,7 +42,7 @@ Include the following hubspot_source package version in your `packages.yml` file
 ```yaml
 packages:
   - package: fivetran/hubspot_source
-    version: [">=0.19.0", "<0.20.0"]
+    version: [">=0.21.0", "<0.22.0"]
 ```
 ### Step 3: Define database and schema variables
 By default, this package runs using your destination and the `hubspot` schema. If this is not where your HubSpot data is (for example, if your HubSpot schema is named `hubspot_fivetran`), add the following configuration to your root `dbt_project.yml` file:
@@ -219,11 +217,11 @@ models:
     hubspot_source:
       +schema: my_new_schema_name # leave blank for just the target_schema
 ```
-    
+
 #### Change the source table references
 If an individual source table has a different name than the package expects, add the table name as it appears in your destination to the respective variable:
 > IMPORTANT: See this project's [`dbt_project.yml`](https://github.com/fivetran/dbt_hubspot_source/blob/main/dbt_project.yml) variable declarations to see the expected names.
-    
+
 ```yml
 vars:
     hubspot_<default_source_table_name>_identifier: your_table_name 
@@ -245,7 +243,7 @@ packages:
     - package: dbt-labs/spark_utils
       version: [">=0.3.0", "<0.4.0"]
 ```
-          
+
 ## How is this package maintained and can I contribute?
 ### Package Maintenance
 The Fivetran team maintaining this package _only_ maintains the latest version of the package. We highly recommend that you stay consistent with the [latest version](https://hub.getdbt.com/fivetran/hubspot_source/latest/) of the package and refer to the [CHANGELOG](https://github.com/fivetran/dbt_hubspot_source/blob/main/CHANGELOG.md) and release notes for more information on changes across versions.

dbt_project.yml

@@ -1,5 +1,5 @@
 name: 'hubspot_source'
-version: '0.20.0'
+version: '0.21.0'
 config-version: 2
 require-dbt-version: [">=1.3.0", "<2.0.0"]
 models:

integration_tests/dbt_project.yml

@@ -1,5 +1,5 @@
 name: 'hubspot_source_integration_tests'
-version: '0.20.0'
+version: '0.21.0'
 profile: 'integration_tests'
 config-version: 2
 
@@ -9,19 +9,19 @@ models:
 vars:
   hubspot_source:
     ## Enable when generating docs
-    # hubspot_service_enabled: true
-    # hubspot_deal_enabled: true
-    # hubspot_contact_enabled: true
-    # hubspot_sales_enabled: true
-    # hubspot_company_enabled: true
-    # hubspot_marketing_enabled: true
-    # hubspot_contact_merge_audit_enabled: true
-    # hubspot_using_all_email_events: true
-    # hubspot_merged_deal_enabled: true  
-    # hubspot_ticket_deal_enabled: true
-    # hubspot_engagement_communication_enabled: true
-    # hubspot_role_enabled: true
-    # hubspot_team_enabled: true
+    # hubspot_service_enabled: true # @docs-include
+    # hubspot_deal_enabled: true # @docs-include
+    # hubspot_contact_enabled: true # @docs-include
+    # hubspot_sales_enabled: true # @docs-include
+    # hubspot_company_enabled: true # @docs-include
+    # hubspot_marketing_enabled: true # @docs-include
+    # hubspot_contact_merge_audit_enabled: true # @docs-include
+    # hubspot_using_all_email_events: true # @docs-include
+    # hubspot_merged_deal_enabled: true # @docs-include
+    # hubspot_ticket_deal_enabled: true # @docs-include
+    # hubspot_engagement_communication_enabled: true # @docs-include
+    # hubspot_role_enabled: true # @docs-include
+    # hubspot_team_enabled: true # @docs-include
 
     hubspot_schema: hubspot_source_integration_tests_34
     hubspot_company_property_history_identifier: "company_property_history_data"
@@ -87,6 +87,8 @@ vars:
     #     alias: "funky_field"
 
 seeds:
+  +docs:
+    show: False
   hubspot_source_integration_tests:
     +quote_columns: "{{ true if target.type == 'redshift' else false }}"
     owner_data:
@@ -254,3 +256,5 @@ dispatch:
 
 flags:
   send_anonymous_usage_stats: False
+
+  use_colors: True