{"id":18992869,"url":"https://github.com/elementary-data/run-elementary-action","last_synced_at":"2026-03-01T11:05:23.741Z","repository":{"id":65159642,"uuid":"523296661","full_name":"elementary-data/run-elementary-action","owner":"elementary-data","description":"A GitHub Action for running Elementary.","archived":false,"fork":false,"pushed_at":"2024-02-04T16:13:08.000Z","size":59,"stargazers_count":29,"open_issues_count":4,"forks_count":10,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-10-18T16:48:14.938Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/elementary-data.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-10T10:20:53.000Z","updated_at":"2025-10-03T01:22:15.000Z","dependencies_parsed_at":"2024-02-04T17:36:29.755Z","dependency_job_id":null,"html_url":"https://github.com/elementary-data/run-elementary-action","commit_stats":{"total_commits":74,"total_committers":4,"mean_commits":18.5,"dds":0.1216216216216216,"last_synced_commit":"04d2ec704d8d53721b1ef61993ed9ff4e1dd7b56"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/elementary-data/run-elementary-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elementary-data%2Frun-elementary-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elementary-data%2Frun-elementary-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elementary-data%2Frun-elementary-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elementary-data%2Frun-elementary-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elementary-data","download_url":"https://codeload.github.com/elementary-data/run-elementary-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elementary-data%2Frun-elementary-action/sbom","scorecard":{"id":372195,"data":{"date":"2025-08-11","repo":{"name":"github.com/elementary-data/run-elementary-action","commit":"f764b45e3efb25d9fbcdf5cc005e6fe86e4745f5"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.3,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"internal error: internal error: invalid GitHub workflow:\n:9:0: could not parse as YAML: yaml: line 9: did not find expected key [syntax-check]","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Pinned-Dependencies","score":-1,"reason":"internal error: internal error: invalid GitHub workflow:\n:9:0: could not parse as YAML: yaml: line 9: did not find expected key [syntax-check]","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Token-Permissions","score":-1,"reason":"internal error: internal error: invalid GitHub workflow:\n:9:0: could not parse as YAML: yaml: line 9: did not find expected key [syntax-check]","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Packaging","score":-1,"reason":"internal error: internal error: invalid GitHub workflow:\n:9:0: could not parse as YAML: yaml: line 9: did not find expected key [syntax-check]","details":null,"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":1,"reason":"Found 2/20 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":9,"reason":"1 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-mr82-8j83-vxmv"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":-1,"reason":"internal error: internal error: invalid GitHub workflow:\n:9:0: could not parse as YAML: yaml: line 9: did not find expected key [syntax-check]","details":null,"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-18T13:13:55.749Z","repository_id":65159642,"created_at":"2025-08-18T13:13:55.749Z","updated_at":"2025-08-18T13:13:55.749Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29967935,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-01T10:55:55.490Z","status":"ssl_error","status_checked_at":"2026-03-01T10:55:55.175Z","response_time":124,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T17:19:08.873Z","updated_at":"2026-03-01T11:05:23.725Z","avatar_url":"https://github.com/elementary-data.png","language":"Python","readme":"# Elementary GitHub Action\n\nThis action allows you to run `edr` as a GitHub Action.  \nIn order to use this action, you will need to create a workflow within your repository.  \nTo create a new workflow, simply create `.github/workflows/elementary.yml` within your repository.\n\nIf you have not yet installed Elementary's dbt package, please refer\nto [this guide](https://docs.elementary-data.com/quickstart#how-to-install-elementary-dbt-package).\n\n## Setup\n\n`edr` requires a dbt connection profile called `elementary` that points to your Elementary schema in the warehouse.\nMore information on that can be found [here](https://docs.elementary-data.com/quickstart-cli).\nAccordingly, we'll need to provide the action with that profile.\n\nIn addition, we recommend that you integrate `edr` with your dbt project.\nThis will make sure that the used data is kept up-to-date by running Elementary's models ahead of time.\nAccordingly, we'll need to `checkout` the dbt project before running the action, and provide its connection profile.\n\nIf you already have a `profiles.yml` in your repository,\ncheckout the repository and pass the environment variables that are used within it to the action.\n`edr` will automatically pick up on the `profiles.yml` file.\n\n```yaml\n- name: Checkout dbt project\n  uses: actions/checkout@v3\n\n- name: Run Elementary\n  uses: elementary-data/run-elementary-action@v1.12\n  env:\n    USER: ${{ secrets.USER }} # Used in profiles.yml.\n    PASSWORD: ${{ secrets.PASSWORD }}\n  with:\n    edr-command: ...\n```\n\nIf you do not have a `profiles.yml` in your repository, you can pass the credentials directly to the action.\nIn order to generate the `profiles.yml` that is needed by `edr` to operate, run the following command within your dbt\nproject:\n\n```shell\ndbt run-operation --args '{\"method\": \"github-actions\"}' elementary.generate_elementary_cli_profile\n```\n\nAfterwards, fill in the missing fields and copy the output to a secret in your repository.\nOnce you've done that, you can pass the secret to the action.\n\n```yaml\n- name: Checkout dbt project\n  uses: actions/checkout@v3\n\n- name: Run Elementary\n  uses: elementary-data/run-elementary-action@v1.11\n  with:\n    profiles-yml: ${{ secrets.ELEMENTARY_PROFILES_YML }}\n    edr-command: ...\n```\n\n## Usage\n\nBelow is a basic example of an Elementary workflow file.  \nFor more information on how to\nuse [GitHub workflows](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions).\n\n```yaml\nname: Run Elementary\non:\n  # Run the action when a push to the main branch of the repository is made.\n  push:\n    branches: [ \"main\", \"master\" ]\n\n  # Run the action when a pull request to the main branch is opened.\n  pull_request:\n    branches: [ \"main\", \"master\" ]\n\n  # Run the action in a scheduled manner every hour.\n  schedule:\n    - cron: '0 * * * *'\n\n  # Allows you to run this workflow manually from the Actions tab.\n  workflow_dispatch:\n\njobs:\n  elementary:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout dbt project\n        uses: actions/checkout@v3\n\n      - name: Run Elementary\n        uses: elementary-data/run-elementary-action@v1.11\n        with:\n          warehouse-type: bigquery # Type of warehouse to use (bigquery, snowflake, redshift, etc.)\n          adapter-version: 1.5.0 # The dbt-adapter version that should be used (If not provided the latest version will be used). \n          profiles-yml: ${{ secrets.ELEMENTARY_PROFILES_YML }} # Content of ~/.dbt/profiles.yml, should have an `elementary` profile.\n          edr-command:\n            edr monitor\n              --slack-token \"${{ secrets.SLACK_TOKEN }}\"\n              --slack-channel-name \"${{ secrets.SLACK_CHANNEL_NAME }}\"\n            \u0026\u0026\n            edr report\n              --file-path \"report.html\"\n            \u0026\u0026\n            edr send-report\n              --slack-token \"${{ secrets.SLACK_TOKEN }}\"\n              --slack-channel-name \"${{ secrets.SLACK_CHANNEL_NAME }}\"\n              --aws-access-key-id \"${{ secrets.AWS_ACCESS_KEY_ID }}\"\n              --aws-secret-access-key \"${{ secrets.AWS_SECRET_ACCESS_KEY }}\"\n              --s3-bucket-name \"${{ secrets.S3_BUCKET_NAME }}\"\n              --google-service-account-path \"/tmp/gcs_keyfile.json\"\n              --gcs-bucket-name \"${{ secrets.GCS_BUCKET_NAME }}\"\n              --update-bucket-website \"true\"\n\n          bigquery-keyfile: ${{ secrets.BIGQUERY_KEYFILE }} # If using BigQuery, the content of its keyfile.\n          gcs-keyfile: ${{ secrets.GCS_KEYFILE }} # If using GCS, the content of its keyfile.\n\n      - name: Upload report\n        uses: actions/upload-artifact@v3\n        with:\n          name: report.html\n          path: report.html\n\n      - name: Upload log\n        if: always()\n        uses: actions/upload-artifact@v3\n        with:\n          name: edr.log\n          path: edr.log\n```\n\n## Configuration\n\n### Elementary Profile\n\nNote that the `profiles-yml` argument needs to be the **content** of `profiles.yml` rather than a path to it.  \nYou can create a secret and then pass it.\n\n```yml\nprofiles-yml: ${{ secrets.PROFILES_YML }}\n```\n\nPlease make sure to quote any field that may contain special characters (For instance `'#$Password\\\u0026^'`).\n\n\u003cimg width=\"1097\" alt=\"image\" src=\"https://user-images.githubusercontent.com/30181361/185250359-918a10ab-b323-4ce3-b598-307ecedadeb9.png\"\u003e\n\n### BigQuery Keyfile Authentication\n\nIf you're using BigQuery with a key file,\nsupply the `bigquery-keyfile` argument to the action and make sure your `keyfile` in the `profiles-yml`\nis `/tmp/bigquery_keyfile.json`.\n\n### Snowflake Keyfile Authentication\n\nIf you're using Snowflake with a key file,\nsupply the `snowflake-keyfile` argument to the action and make sure your `private_key_path` in the `profiles-yml`\nis `/tmp/snowflake_keyfile.key`.\n\n### Google Cloud Storage Keyfile\n\nIf you want to upload your report to a Google Cloud Storage bucket using `send-report`,\nsupply the `gcs-keyfile` argument to the action with the **content** of your Google service account keyfile.\nAfterwards, use `edr monitor send-report --google-service-account-path /tmp/gcs_keyfile.json` to upload the report.\n\n## Having trouble?\n\nPlease contact us\non [Slack](https://join.slack.com/t/elementary-community/shared_invite/zt-uehfrq2f-zXeVTtXrjYRbdE_V6xq4Rg), we're here\nto help!\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felementary-data%2Frun-elementary-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felementary-data%2Frun-elementary-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felementary-data%2Frun-elementary-action/lists"}