<@U088WCP3B4P> how do I run edr report using githu...
# ask-elementary-ai
d
@kapa.ai how do I run edr report using github action when I have a dbt cloud
k
A message from kapa.ai
To run
edr report
using GitHub Actions when your dbt project is orchestrated by dbt Cloud, you need to: 1. Ensure the Elementary dbt package is installed in your dbt project and that your dbt Cloud jobs are writing the necessary artifacts to your data warehouse (DWH). The Elementary dbt package will handle this automatically as part of your dbt runs in dbt Cloud, writing outputs to the elementary schema in your DWH [see here](https://slack.com/archives/C02CTC89LAX/p1686334697024729). 2. Set up a GitHub Action that runs the Elementary CLI (
edr report
) after your dbt Cloud job completes. Since dbt Cloud cannot run non-dbt commands, you must orchestrate
edr report
separately—GitHub Actions is a common choice for this [see here](https://slack.com/archives/C02CTC89LAX/p1678312037552069). 3. In your GitHub Action, provide a
profiles.yml
(as a secret or file) that allows the Elementary CLI to connect to the same data warehouse and schema used by your dbt Cloud job. Here’s a sample GitHub Actions workflow for running
edr report
(for example, with Snowflake):
Copy code
yaml name: Run Elementary on:   workflow_dispatch: jobs:   elementary:     runs-on: ubuntu-latest     steps:       - name: Checkout dbt project         uses: actions/checkout@v3       - name: Run Elementary         uses: elementary-data/run-elementary-action@v1.11         with:           warehouse-type: snowflake           adapter-version: 1.5.0           profiles-yml: ${{ secrets.ELEMENTARY_PROFILES_YML }}           edr-command: |             edr report --file-path "report.html"       - name: Upload report         uses: actions/upload-artifact@v3         with:           name: report.html           path: report.html       - name: Upload log         if: always()         uses: actions/upload-artifact@v3         with:           name: edr.log           path: edr.log
Key points: - The
profiles.yml
must point to the same warehouse/schema as your dbt Cloud job. - You can schedule this workflow or trigger it after your dbt Cloud job (using webhooks if available, or on a schedule). - The report will be generated based on the artifacts written by dbt Cloud to your DWH [see here](https://slack.com/archives/C02CTC89LAX/p1686334697024729). You cannot run
edr report
directly inside dbt Cloud, but this approach allows you to generate and share reports using GitHub Actions after your dbt Cloud jobs complete [see here](https://slack.com/archives/C02CTC89LAX/p1678312037552069).
d
@kapa.ai can I deploy it then to Github Pages?
k
A message from kapa.ai
Yes, you can deploy the Elementary data observability report to GitHub Pages. Users have successfully generated the report using the
edr report
command and then published it to platforms like GitHub Pages by copying the generated HTML file(s) to the appropriate directory (often as
index.html
) for static site hosting. This approach is similar to how users deploy dbt docs or other static reports. For example, one user described generating the report and copying it to a public directory for deployment, which is compatible with GitHub Pages workflows [see example](https://slack.com/archives/C02CTC89LAX/p1695986985130289). To summarize: - Run
edr report
to generate the HTML report. - Copy the resulting HTML file (e.g.,
elementary_report.html
or rename it to
index.html
) to the directory used by GitHub Pages (commonly
public
or
docs
). - Push this directory to the branch configured for GitHub Pages. This will make your Elementary report accessible via GitHub Pages.
d
@kapa.ai can you show me all threads where Github Pages deploy was asked and answered
k
A message from kapa.ai
Certainly! Based on the knowledge sources provided, here are the threads where deploying the Elementary report to GitHub Pages was asked and answered: 1. Thread about hosting the report on GitHub Pages and lineage issues: - Question: A user asked about using GitHub Pages to host the EDR Report and mentioned an issue with the lineage page not displaying correctly, even though it worked locally. - Answer: The support staff requested more details, such as a link to the hosted page or JavaScript errors from the browser inspector, to help debug the issue. The conversation focused on troubleshooting the deployment rather than the deployment process itself, but it confirms that users are deploying to GitHub Pages and encountering related questions [see the thread here](https://slack.com/archives/C02CTC89LAX/p1697836245503829). 2. Thread about orchestrating Elementary with GitLab CI and a mention of GitLab Pages: - Question: A user asked for documentation or a guide on how to host the Elementary report on GitLab Pages. - Answer: The support staff provided a guide for orchestrating Elementary with GitLab CI and suggested that, since the report is a static HTML file, it could be uploaded to a GitLab repo and served via GitLab Pages, referencing an external guide for rendering HTML on GitLab Pages. While this is about GitLab Pages, the process is analogous to GitHub Pages and demonstrates the static nature of the report [see the thread here](https://slack.com/archives/C02CTC89LAX/p1678326246816089). There is no thread in the provided sources with a direct, step-by-step answer specifically for deploying to GitHub Pages, but the first thread confirms that users are doing so and seeking support for related issues. If you need a step-by-step guide, let me know!