Add dbt documentation site with GitHub Pages and CI/CD auto-update

[Copilot]

Implements automated dbt documentation generation and deployment to GitHub Pages, triggered on every push to main.

Changes

CI/CD Pipeline

• .github/workflows/deploy-dbt-docs.yml: Generates dbt docs using --empty-catalog (no DB connection required), deploys to GitHub Pages via actions/deploy-pages@v4
• Triggers: push to main, manual dispatch
• Permissions configured for Pages deployment

Local Development

• mise.toml: Added dbt:docs:generate and dbt:docs:serve tasks
• Creates minimal profiles.yml automatically if missing
• Works without database connection

Documentation

• .github/GITHUB_PAGES_SETUP.md: Admin setup guide for enabling GitHub Pages
• dbt/README.md: Local preview instructions with mise and manual commands
• README.md: Link to live docs site

Usage

Deploy (automatic): Push to main → docs at https://summers-team.github.io/school-m2-bi-project/

Local preview:

mise run dbt:docs:serve  # generates and serves at localhost:8080

Setup Required

Repository admin must enable GitHub Pages:

1. Settings → Pages
2. Set Source to "GitHub Actions"

See .github/GITHUB_PAGES_SETUP.md for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• fishtownanalytics.sinter-collect.com
  • Triggering command: /home/REDACTED/work/school-m2-bi-project/school-m2-bi-project/.venv/bin/python /home/REDACTED/work/school-m2-bi-project/school-m2-bi-project/.venv/bin/dbt docs generate --profiles-dir . --no-compile (dns block)
  • Triggering command: /home/REDACTED/work/school-m2-bi-project/school-m2-bi-project/.venv/bin/python /home/REDACTED/work/school-m2-bi-project/school-m2-bi-project/.venv/bin/dbt docs generate --profiles-dir . --empty-catalog (dns block)
  • Triggering command: /home/REDACTED/work/school-m2-bi-project/school-m2-bi-project/.venv/bin/python /home/REDACTED/work/school-m2-bi-project/school-m2-bi-project/.venv/bin/dbt parse --profiles-dir . (dns block)
• mise.run
  • Triggering command: curl REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Add dbt documentation site with GitHub Pages and CI/CD auto-update</issue_title>
<issue_description>## Overview

To improve dbt model transparency and user awareness, set up automated documentation generation:

• Use a static site generator to build dbt documentation.
• Deploy documentation to GitHub Pages for public access.
• Build and update docs automatically with a CI/CD workflow upon pushing to the main branch.

Tasks

• Integrate dbt docs generation into the repo (e.g., dbt docs generate).
• Configure a static site generator appropriate for dbt docs (or use dbt's site if preferred).
• Automate site deployment to GitHub Pages (actions or workflow suggestion).
• Set up a CI/CD workflow (e.g., GitHub Actions) to generate and deploy the docs automatically on every push to main.
• Provide instructions on how to preview docs locally.

Acceptance criteria

• GitHub Pages reliably serves up-to-date dbt documentation.
• CI/CD workflow triggers on main branch updates, rebuilding and redeploying docs without manual intervention.
• Docs can be previewed locally by contributors.

---

This will streamline sharing project documentation and foster a better understanding of BI pipeline modeling with dbt.
</issue_description>

<agent_instructions>Using mise as env manager</agent_instructions>

Comments on the Issue (you are @copilot in this section)

• Fixes Add dbt documentation site with GitHub Pages and CI/CD auto-update #6

---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.