You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+24Lines changed: 24 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,27 @@
1
+
# dbt_github v1.0.0
2
+
3
+
[PR #67](https://github.com/fivetran/dbt_github/pull/67) includes the following updates:
4
+
5
+
## Breaking Changes
6
+
7
+
### Source Package Consolidation
8
+
- Removed the dependency on the `fivetran/github_source` package.
9
+
- All functionality from the source package has been merged into this transformation package for improved maintainability and clarity.
10
+
- If you reference `fivetran/github_source` in your `packages.yml`, you must remove this dependency to avoid conflicts.
11
+
- Any source overrides referencing the `fivetran/github_source` package will also need to be removed or updated to reference this package.
12
+
- Update any github_source-scoped variables to be scoped to only under this package. See the [README](https://github.com/fivetran/dbt_github/blob/main/README.md) for how to configure the build schema of staging models.
13
+
- As part of the consolidation, vars are no longer used to reference staging models, and only sources are represented by vars. Staging models are now referenced directly with `ref()` in downstream models.
14
+
15
+
### dbt Fusion Compatibility Updates
16
+
- Updated package to maintain compatibility with dbt-core versions both before and after v1.10.6, which introduced a breaking change to multi-argument test syntax (e.g., `unique_combination_of_columns`).
17
+
- Temporarily removed unsupported tests to avoid errors and ensure smoother upgrades across different dbt-core versions. These tests will be reintroduced once a safe migration path is available.
18
+
- Removed all `dbt_utils.unique_combination_of_columns` tests.
19
+
- Moved `loaded_at_field: _fivetran_synced` under the `config:` block in `src_github.yml`.
20
+
21
+
### Under the Hood
22
+
- Updated conditions in `.github/workflows/auto-release.yml`.
23
+
- Added `.github/workflows/generate-docs.yml`.
24
+
1
25
# dbt_github v0.9.1
2
26
3
27
[PR #64](https://github.com/fivetran/dbt_github/pull/64) includes the following updates:
- Produces modeled tables that leverage Github data from [Fivetran's connector](https://fivetran.com/docs/applications/github) in the format described by [this ERD](https://fivetran.com/docs/applications/github#schemainformation) and builds off of the output from our [github source package](https://github.com/fivetran/dbt_github_source).
21
-
19
+
- Produces modeled tables that leverage GitHub data from [Fivetran's connector](https://fivetran.com/docs/applications/github) in the format described by [this ERD](https://fivetran.com/docs/applications/github#schemainformation).
22
20
- Provides insight into GitHub issues and pull requests by enhancing these core objects with commonly used metrics.
23
21
- Produces metrics tables, which increase understanding of your team's velocity over time. Metrics are available on a daily, weekly, monthly, and quarterly level.
24
22
- Generates a comprehensive data dictionary of your source and modeled github data through the [dbt docs site](https://fivetran.github.io/dbt_github/).
@@ -44,7 +42,7 @@ Each Quickstart transformation job run materializes 34 models if all components
44
42
### Step 1: Prerequisites
45
43
To use this dbt package, you must have the following:
46
44
47
-
- At least one Fivetran Github connection syncing data into your destination.
45
+
- At least one Fivetran GitHub connection syncing data into your destination.
48
46
- A **BigQuery**, **Snowflake**, **Redshift**, **PostgreSQL**, or **Databricks** destination.
49
47
50
48
#### Databricks Dispatch Configuration
@@ -62,24 +60,23 @@ Include the following github package version in your `packages.yml` file.
62
60
```yaml
63
61
packages:
64
62
- package: fivetran/github
65
-
version: [">=0.9.0", "<0.10.0"] # we recommend using ranges to capture non-breaking changes automatically
63
+
version: [">=1.0.0", "<1.1.0"] # we recommend using ranges to capture non-breaking changes automatically
66
64
```
67
65
68
-
Do NOT include the `github_source` package in this file. The transformation package itself has a dependency on it and will install the source package as well.
69
-
66
+
> All required sources and staging models are now bundled into this transformation package. Do not include `fivetran/github_source` in your `packages.yml` since this package has been deprecated.
70
67
71
68
### Step 3: Define database and schema variables
72
-
By default, this package runs using your [destination](https://docs.getdbt.com/docs/running-a-dbt-project/using-the-command-line-interface/configure-your-profile) and the `github` schema. If this is not where your Github data is (for example, if your github schema is named `github_fivetran`), add the following configuration to your root `dbt_project.yml` file:
69
+
By default, this package runs using your [destination](https://docs.getdbt.com/docs/running-a-dbt-project/using-the-command-line-interface/configure-your-profile) and the `github` schema. If this is not where your GitHub data is (for example, if your github schema is named `github_fivetran`), add the following configuration to your root `dbt_project.yml` file:
73
70
74
71
```yml
75
72
vars:
76
-
github_source:
73
+
github:
77
74
github_database: your_database_name
78
75
github_schema: your_schema_name
79
76
```
80
77
81
78
### Step 4: Disable models for non-existent sources
82
-
Your Github connection might not sync every table that this package expects. If your syncs exclude certain tables, it is because you either don't use that functionality in Github or have actively excluded some tables from your syncs.
79
+
Your GitHub connection might not sync every table that this package expects. If your syncs exclude certain tables, it is because you either don't use that functionality in GitHub or have actively excluded some tables from your syncs.
83
80
84
81
If you do not have the `TEAM`, `REPO_TEAM`, `ISSUE_ASSIGNEE`, `ISSUE_LABEL`, `LABEL`, or `REQUESTED_REVIEWER_HISTORY` tables synced and are not running the package via Fivetran Quickstart, add the following variables to your `dbt_project.yml` file:
By default, this package builds the Github staging models within a schema titled (`<target_schema>` + `_github_source`) and your Github modeling models within a schema titled (`<target_schema>` + `_github`) in your destination. If this is not where you would like your Github data to be written to, add the following configuration to your root `dbt_project.yml` file:
99
+
By default, this package builds the GitHub staging models within a schema titled (`<target_schema>` + `_github_source`) and your GitHub modeling models within a schema titled (`<target_schema>` + `_github`) in your destination. If this is not where you would like your GitHub data to be written to, add the following configuration to your root `dbt_project.yml` file:
103
100
104
101
```yml
105
102
models:
106
-
github_source:
107
-
+schema: my_new_schema_name # leave blank for just the target_schema
108
103
github:
109
-
+schema: my_new_schema_name # leave blank for just the target_schema
104
+
+schema: my_new_schema_name # Leave +schema: blank to use the default target_schema.
105
+
staging:
106
+
+schema: my_new_schema_name # Leave +schema: blank to use the default target_schema.
110
107
```
111
108
#### Change the source table references
112
109
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:
113
110
114
-
> IMPORTANT: See this project's [`dbt_project.yml`](https://github.com/fivetran/dbt_github_source/blob/main/dbt_project.yml) variable declarations to see the expected names.
111
+
> IMPORTANT: See this project's [`dbt_project.yml`](https://github.com/fivetran/dbt_github/blob/main/dbt_project.yml) variable declarations to see the expected names.
115
112
116
113
```yml
117
114
vars:
@@ -129,7 +126,7 @@ Fivetran offers the ability for you to orchestrate your dbt project through [Fiv
129
126
## Does this package have dependencies?
130
127
This dbt package is dependent on the following dbt packages. These dependencies are installed by default within this package. For more information on the following packages, refer to the [dbt hub](https://hub.getdbt.com/) site.
131
128
> IMPORTANT: If you have any of these dependent packages in your own `packages.yml` file, we highly recommend that you remove them from your root `packages.yml` to avoid package version conflicts.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments