Skip to content

create openlineage docs#33854

Merged
cmpadden merged 5 commits into
dagster-io:masterfrom
michalcabir-ui:docs/dagster-openlineage-v0.2
May 27, 2026
Merged

create openlineage docs#33854
cmpadden merged 5 commits into
dagster-io:masterfrom
michalcabir-ui:docs/dagster-openlineage-v0.2

Conversation

@michalcabir-ui

Copy link
Copy Markdown
Contributor

Summary & Motivation

  • Adds docs/docs/integrations/libraries/openlineage.md — new community integration page for dagster-openlineage
    v0.2.0 (released on PyPI: https://pypi.org/project/dagster-openlineage/0.2.0/)
  • Adds docs/static/images/integrations/openlineage.svg — sidebar logo using OpenLineage brand color (#74A4BC)

The page documents both emission mechanisms introduced in v0.2:

  • Mechanism A (OpenLineageEventLogStorage storage wrapper) — push-based, for self-hosted OSS Dagster deployments
    that control instance.yaml
  • Mechanism B (openlineage_sensor(include_asset_events=True)) — poll-based, for Dagster+
    Hybrid/Serverless/Branch Deployments

Also covers: v0.2 feature set (schema facet, column lineage facet, data quality assertions, partition nominal-time),
namespace templates, compatibility matrix, and migration notes from v0.1.

Related merged PR in community-integrations: dagster-io/community-integrations#284

@greptile-apps

greptile-apps Bot commented May 21, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Adds a new community integration page for dagster-openlineage v0.2 along with an SVG sidebar logo, covering both emission mechanisms, namespace templates, the full feature set, and migration notes from v0.1.

  • New doc (openlineage.md): explains Mechanism A (storage wrapper via instance.yaml) and Mechanism B (sensor), includes a compatibility matrix, feature list, namespace-template examples, and a v0.1 → v0.2 breaking-change summary.
  • New asset (openlineage.svg): minimal branded icon using the OpenLineage blue (#74A4BC) with proper <title>, role="img", and aria-label for accessibility.
  • All issues raised in earlier review rounds (namespace example scoping, {tag:KEY} caveat in Mechanism A, SVG title, missing migration section) have been addressed.

Confidence Score: 5/5

Documentation-only change with no runtime code; safe to merge.

Both files are purely additive docs and assets. The YAML config key (postgres_url) and module path (dagster_postgres.event_log) were verified against the actual Dagster source and are correct. All previous review-round concerns have been addressed in the current revision. No executable code is touched.

No files require special attention.

Important Files Changed

Filename Overview
docs/docs/integrations/libraries/openlineage.md New community integration page for dagster-openlineage v0.2; documents both emission mechanisms (storage wrapper and sensor), namespace templates, features, and v0.1→v0.2 migration notes. Minor: namespace-template example block has no language specifier.
docs/static/images/integrations/openlineage.svg New SVG logo using OpenLineage brand color; includes <title>, role="img", and aria-label for accessibility.

Reviews (3): Last reviewed commit: "fix remarks" | Re-trigger Greptile

Comment thread docs/docs/integrations/libraries/openlineage.md
Comment thread docs/docs/integrations/libraries/openlineage.md Outdated
Comment thread docs/static/images/integrations/openlineage.svg Outdated
Comment thread docs/docs/integrations/libraries/openlineage.md
michalcabir-ui and others added 4 commits May 21, 2026 18:05
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
@cmpadden
cmpadden requested review from a team and cmpadden May 21, 2026 15:19
@cmpadden
cmpadden added this pull request to the merge queue May 27, 2026
Merged via the queue into dagster-io:master with commit 320b0ed May 27, 2026
2 of 4 checks passed
elementl-devtools pushed a commit that referenced this pull request May 27, 2026
## Summary & Motivation

Two master-red fixes, bundled at request.

**1. `admin-cloud` lint failure — JS tox step CWD regression from
#24923.** #24923 unified the internal and OSS tox-step factories into
`buildkite_shared.tox.build_tox_step`. The shared factory assembles
commands as `[*extra_commands_pre, "cd {directory}", …, tox]` — it runs
`extra_commands_pre` from the repo root, *before* `cd`-ing into the
package directory (the OSS convention). The internal JS steps
(`app-cloud`, `login-app`, `admin-cloud`) were written for the *old*
internal convention where `cd {directory}` ran first, so their `pushd
../../..` (intended: package dir → repo root) overshot from the repo
root all the way to `/`. The "install the root yarn workspace" step
became a silent no-op — corepack fell back to yarn 1.22.22 at `/`, found
no lockfile, and finished in 0.1s.

Only `admin-cloud` broke. It's a standalone yarn project (its own
`.yarnrc.yml` + `yarn.lock`) and pulls in `@dagster-io/eslint-config`
via `link:`, which does not install that package's transitive deps. So
`eslint-config-prettier` is only resolvable when the *root* workspace
was installed — which it wasn't — and `yarn lint` failed with `Cannot
find module 'eslint-config-prettier'`. `app-cloud`/`login-app` are
root-workspace members, so their in-tox `yarn install` resolved the root
workspace anyway and masked the bug.

Fix: target the repo root explicitly via
`$BUILDKITE_BUILD_CHECKOUT_PATH` (the same escaping/pattern the
app-cloud backcompat steps in this file already use) instead of the
CWD-relative `../../..`, and run `admin-cloud`'s `yarn -v` pre-download
inside its own directory. The shared factory is left untouched, so OSS
steps — whose `extra_commands_pre` are already repo-root-relative
(`pushd {oss_path(...)}`) — are unaffected.

**2. `build-docs` prettier failure.** The markdown table in
`dagster-oss/docs/docs/integrations/libraries/openlineage.md` (added in
#33854) wasn't column-aligned and failed `yarn lint-check`. Reformatted
to satisfy prettier.

## Test Plan

- Rendered the `admin-cloud` step and confirmed the command order:
`corepack enable` → `pushd $BUILDKITE_BUILD_CHECKOUT_PATH` → `yarn` →
`popd` → `pushd
$BUILDKITE_BUILD_CHECKOUT_PATH/dagster-cloud/js_modules/admin-cloud` →
`yarn -v` → `popd` → `cd dagster-cloud/js_modules/admin-cloud` → `tox`.
The balanced `pushd`/`popd` leaves CWD at the repo root, so the
factory's relative `cd {directory}` still resolves.
- `ruff check` and `ruff format --check` clean on the edited step file.
- `prettier --check` clean on `openlineage.md` after the reformat; the
diff touches only the table.
- Relying on Buildkite on this PR to confirm `admin-cloud-default-3-12`
and `build-docs` go green.

## Changelog

NOCHANGELOG

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Internal-RevId: a68966bb5b0a497db1e83e1908878a73b4c091ce
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants