Skip to content

README.md

Latest commit

 

History

History
68 lines (46 loc) · 1.57 KB

README.md

File metadata and controls

68 lines (46 loc) · 1.57 KB

Elementary CI

Automated data quality review for Pull Requests and Merge Requests.

When a developer opens or updates a PR/MR, this action:

  1. Sends the repository name and branch to the Elementary API
  2. Elementary fetches the diff, analyses test results, active incidents, and downstream lineage
  3. Posts a summary comment to the PR/MR (updates it on reruns - no spam)

Prerequisites: Connect your code repository in the Elementary Cloud UI.

GitHub Actions

Quick start

# .github/workflows/elementary-review.yml
name: Elementary Data Quality Review

on:
  pull_request:

jobs:
  elementary-review:
    runs-on: ubuntu-latest
    steps:
      - uses: elementary-data/elementary-ci@v1
        with:
          elementary-api-key: ${{ secrets.ELEMENTARY_API_KEY }}

Inputs

Input Default Description
elementary-api-key required Elementary Cloud API key

Required secrets

Secret Description
ELEMENTARY_API_KEY Elementary Cloud API key

GITHUB_TOKEN is provided automatically by GitHub Actions.

GitLab CI/CD Component

Quick start

# .gitlab-ci.yml
include:
  - component: gitlab.com/elementary-data/ci-components/mr-review@v1

Required CI/CD variables

Set these in Settings > CI/CD > Variables (mark sensitive ones as masked):

Variable Description
ELEMENTARY_API_KEY Elementary Cloud API key

CI_JOB_TOKEN is provided automatically. Optionally set GITLAB_API_TOKEN (project/group token with api scope) if CI_JOB_TOKEN lacks comment permissions.