feature/freshness-updates (#44)

* feature/freshness-updates

* pr ref fix

Author: fivetran-joemarkiewicz

.buildkite/pipeline.yml

@@ -3,7 +3,7 @@ steps:
     key: "run-dbt-postgres"
     plugins:
       - docker#v3.13.0:
-          image: "python:3.8"
+          image: "python:3.10.13"
           shell: [ "/bin/bash", "-e", "-c" ]
           environment:
             - "BASH_ENV=/tmp/.bashrc"
@@ -18,7 +18,7 @@ steps:
     key: "run_dbt_snowflake"
     plugins:
       - docker#v3.13.0:
-          image: "python:3.8"
+          image: "python:3.10.13"
           shell: [ "/bin/bash", "-e", "-c" ]
           environment:
             - "BASH_ENV=/tmp/.bashrc"
@@ -35,7 +35,7 @@ steps:
     key: "run_dbt_bigquery"
     plugins:
       - docker#v3.13.0:
-          image: "python:3.8"
+          image: "python:3.10.13"
           shell: [ "/bin/bash", "-e", "-c" ]
           environment:
             - "BASH_ENV=/tmp/.bashrc"
@@ -47,7 +47,7 @@ steps:
     key: "run_dbt_redshift"
     plugins:
       - docker#v3.13.0:
-          image: "python:3.8"
+          image: "python:3.10.13"
           shell: [ "/bin/bash", "-e", "-c" ]
           environment:
             - "BASH_ENV=/tmp/.bashrc"
@@ -62,7 +62,7 @@ steps:
     key: "run_dbt_databricks"
     plugins:
       - docker#v3.13.0:
-          image: "python:3.8"
+          image: "python:3.10.13"
           shell: [ "/bin/bash", "-e", "-c" ]
           environment:
             - "BASH_ENV=/tmp/.bashrc"

.buildkite/scripts/run_models.sh

@@ -17,6 +17,7 @@ echo `pwd`
 cd integration_tests
 dbt deps
 dbt seed --target "$db" --full-refresh
+dbt source freshness --target "$db" || echo "...Only verifying freshness runs..."
 dbt run --target "$db" --full-refresh
 dbt test --target "$db"
 dbt run --vars '{github__using_repo_team: false}' --target "$db" --full-refresh

.gitignore

@@ -3,4 +3,5 @@ target/
 dbt_modules/
 logs/
 .DS_Store
-dbt_packages/
+dbt_packages/
+env/

CHANGELOG.md

@@ -1,8 +1,33 @@
-# dbt_github_source version.version
+# dbt_github_source v0.9.0
+
+[PR #44](https://github.com/fivetran/dbt_github_source/pull/44) includes the following updates:
+
+## Breaking Change for dbt Core < 1.9.6
+
+> *Note: This is not relevant to Fivetran Quickstart users.*
+
+Migrated `freshness` from a top-level source property to a source `config` in alignment with [recent updates](https://github.com/dbt-labs/dbt-core/issues/11506) from dbt Core. This will resolve the following deprecation warning that users running dbt >= 1.9.6 may have received:
+
+```
+[WARNING]: Deprecated functionality
+Found `freshness` as a top-level property of `github` in file
+`models/src_github.yml`. The `freshness` top-level property should be moved
+into the `config` of `github`.
+```
+
+**IMPORTANT:** Users running dbt Core < 1.9.6 will not be able to utilize freshness tests in this release or any subsequent releases, as older versions of dbt will not recognize freshness as a source `config` and therefore not run the tests.
+
+If you are using dbt Core < 1.9.6 and want to continue running Github Source freshness tests, please elect **one** of the following options:
+  1. (Recommended) Upgrade to dbt Core >= 1.9.6
+  2. Do not upgrade your installed version of the `github_source` package. Pin your dependency on v0.8.0 in your `packages.yml` file.
+  3. Utilize a dbt [override](https://docs.getdbt.com/reference/resource-properties/overrides) to overwrite the package's `github` source and apply freshness via the previous release top-level property route. This will require you to copy and paste the entirety of the previous release `src_github.yml` file and add an `overrides: github_source` property.
 
 ## Documentation
 - Corrected references to connectors and connections in the README. ([#42](https://github.com/fivetran/dbt_github_source/pull/42))
 
+## Under the Hood
+- Updates to ensure integration tests use latest version of dbt.
+
 # dbt_github_source v0.8.0
 [PR #39](https://github.com/fivetran/dbt_jira/dbt_github_source/39) contains the following updates:
 

README.md

@@ -20,6 +20,7 @@
 - Materializes [Github staging tables](https://fivetran.github.io/dbt_github_source/#!/overview/github_source/models/?g_v=1&g_e=seeds) which leverage data in the format described by [this ERD](https://fivetran.com/docs/applications/github/#schemainformation). These staging tables clean, test, and prepare your Github data from [Fivetran's connector](https://fivetran.com/docs/applications/github) for analysis by doing the following:
   - Name columns for consistency across all packages and for easier analysis
   - Adds freshness tests to source data
+    - dbt Core >= 1.9.6 is required to run freshness tests out of the box
   - Adds column-level testing where applicable. For example, all primary keys are tested for uniqueness and non-null values.
 - Generates a comprehensive data dictionary of your Github data through the [dbt docs site](https://fivetran.github.io/dbt_github_source/).
 - These tables are designed to work simultaneously with our [Github transformation package](https://github.com/fivetran/dbt_github).
@@ -45,7 +46,7 @@ Include the following github_source package version in your `packages.yml` file.
 ```yaml
 packages:
   - package: fivetran/github_source
-    version: [">=0.8.0", "<0.9.0"] # we recommend using ranges to capture non-breaking changes automatically
+    version: [">=0.9.0", "<0.10.0"] # we recommend using ranges to capture non-breaking changes automatically
 ```
 
 ### Step 3: Define database and schema variables

dbt_project.yml

@@ -1,6 +1,6 @@
 config-version: 2
 name: 'github_source'
-version: '0.8.0'
+version: '0.9.0'
 require-dbt-version: [">=1.3.0", "<2.0.0"]
 models:
   github_source:

integration_tests/ci/sample.profiles.yml

@@ -2,10 +2,6 @@
 # HEY! This file is used in the dbt package integrations tests with Buildkite.
 # You should __NEVER__ check credentials into version control. Thanks for reading :)
 
-config:
-    send_anonymous_usage_stats: False
-    use_colors: True
-
 integration_tests:
   target: redshift
   outputs:

integration_tests/dbt_project.yml

@@ -1,5 +1,5 @@
 name: 'github_source_integration_tests'
-version: '0.8.0'
+version: '0.9.0'
 config-version: 2
 profile: 'integration_tests'
 vars:
@@ -58,4 +58,7 @@ seeds:
 
 dispatch:
   - macro_namespace: dbt_utils
-    search_order: ['spark_utils', 'dbt_utils']
+    search_order: ['spark_utils', 'dbt_utils']
+
+flags:
+  send_anonymous_usage_stats: False

integration_tests/requirements.txt

@@ -4,4 +4,5 @@ dbt-redshift>=1.3.0,<2.0.0
 dbt-postgres>=1.3.0,<2.0.0
 dbt-spark>=1.3.0,<2.0.0
 dbt-spark[PyHive]>=1.3.0,<2.0.0
-dbt-databricks>=1.3.0,<2.0.0
+dbt-databricks>=1.3.0,<2.0.0
+certifi==2025.1.31

models/src_github.yml

@@ -6,9 +6,10 @@ sources:
     schema: "{{var ('github_schema', 'github')}}"
     loader: Fivetran
     loaded_at_field: _fivetran_synced
-    freshness:
-      warn_after: {count: 72, period: hour}
-      error_after: {count: 168, period: hour}
+    config:
+      freshness:
+        warn_after: {count: 72, period: hour}
+        error_after: {count: 168, period: hour}
 
 
     tables:
@@ -25,7 +26,8 @@ sources:
       - name: label
         identifier:  "{{ var('github_label_identifier', 'label')}}"
         description: Table that contains labels that are used across your Github account within individual repositories.
-        freshness: null
+        config:
+          freshness: null
         columns:
           - name: id
             description: Unique identifier of the Github label
@@ -164,7 +166,8 @@ sources:
       - name: repository
         identifier:  "{{ var('github_repository_identifier', 'repository')}}"
         description: Table representing the file structure of a directory under git control
-        freshness: null
+        config:
+          freshness: null
         columns:
           - name: id
             description: System generated unique id for the repository.
@@ -209,7 +212,8 @@ sources:
       - name: user
         identifier:  "{{ var('github_user_identifier', 'user')}}"
         description: Table representing contributors to a git project
-        freshness: null
+        config:
+          freshness: null
         columns:
           - name: id
             description: System generated unique id for the user.