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: README.md
+14-3Lines changed: 14 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,23 @@
1
1
# dbt-docs-to-notion
2
+
2
3
A Github action for exporting dbt model docs to a Notion database, where they can be conveniently consumed (especially by casual users in your org).
3
4
4
5
## Output
6
+
5
7
A Notion database, within a page of your choosing, with records like this:
6
8

7
9
8
10
## Usage
11
+
9
12
### Prerequisites
13
+
10
14
In advance of using this action, you should:
15
+
11
16
1.[Create a new integration within your Notion workspace](https://www.notion.so/my-integrations)
12
17
2. Have your Notion integration token and a working dbt `profiles.yml` accessible to your repo (I'd recommend using [Github's repository secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets); see example workflow below).
18
+
13
19
### Inputs
20
+
14
21
-`dbt-package`: dbt-bigquery, dbt-postgres, dbt-bigquery==1.0.0, etc. (**required**)
15
22
-`dbt-profile-path`: where profile.yml lives (default: `./`)
16
23
-`dbt-target`: profile target to use for dbt docs generation (**required**)
@@ -20,14 +27,18 @@ In advance of using this action, you should:
20
27
-`notion-token`: Notion token API for integration to use (pass using secrets) (**required**)
21
28
22
29
### Post-initialization Touchups
30
+
23
31
Unfortunately, Notion's API doesn't allow for setting the order of properties or records in a database. Thus, after creating your database, you'll probably want to do some re-arranging (I'd recommend adding a table view to your database's parent page).
0 commit comments