Merge pull request #81 from Synthetixio/feat/dbt-docs-pages

Create Docs Directory for GitHub Pages
Synthetixio · Jul 18, 2024 · 59cae18 · 59cae18
2 parents a8313bd + d57cdda
commit 59cae18
Show file tree

Hide file tree

Showing 5 changed files with 149 additions and 0 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,44 @@
+name: documentation
+
+# on all pull requests
+# on pushes to the main branch
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up python
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.10.11
+      - name: Install python dependencies
+        run: |
+          cd transformers && pip install -r requirements.txt
+      - name: Install dbt dependencies
+        run: |
+          cd transformers/synthetix && dbt deps
+      - name: Build docs
+        run: |
+          cd transformers/synthetix && dbt docs generate --profiles-dir profiles --profile synthetix-host
+        env:
+          PG_HOST: ${{ secrets.PG_HOST }}
+          PG_PASSWORD: ${{ secrets.PG_PASSWORD }}
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: target
+          force_orphan: true
diff --git a/transformers/synthetix/docs/catalog.json b/transformers/synthetix/docs/catalog.json
diff --git a/transformers/synthetix/docs/index.html b/transformers/synthetix/docs/index.html
diff --git a/transformers/synthetix/docs/manifest.json b/transformers/synthetix/docs/manifest.json
diff --git a/transformers/synthetix/profiles/profiles.yml b/transformers/synthetix/profiles/profiles.yml
@@ -25,3 +25,31 @@ synthetix:
       connect_timeout: 10
       retries: 1
       threads: 4
+
+synthetix-host:
+  target: prod
+  outputs:
+    prod:
+      type: postgres
+      host: "{{ env_var('PG_HOST') }}"
+      user: analytics
+      password: "{{ env_var('PG_PASSWORD') }}"
+      port: 23798
+      dbname: analytics
+      schema: prod
+      keepalives_idle: 0
+      connect_timeout: 10
+      retries: 1
+      threads: 4
+    prod-op:
+      type: postgres
+      host: localhost
+      user: analytics
+      password: "{{ env_var('PG_PASSWORD') }}"
+      port: 23798
+      dbname: analytics
+      schema: prod
+      keepalives_idle: 0
+      connect_timeout: 10
+      retries: 1
+      threads: 4