Skip to content

docs: EtlPipeline Create()/DisposingOwned docs + Example9 - #286

Merged
Chris-Wolfgang merged 1 commit into
vNextfrom
docs/etlpipeline-0.16.0
Jul 21, 2026
Merged

docs: EtlPipeline Create()/DisposingOwned docs + Example9#286
Chris-Wolfgang merged 1 commit into
vNextfrom
docs/etlpipeline-0.16.0

Conversation

@Chris-Wolfgang

Copy link
Copy Markdown
Owner

Summary

Brings the EtlPipeline documentation and examples in line with the shipped 0.16.0 API, before release.

Docs fixes (were wrong)

  • getting-started.md / introduction.md: every EtlPipeline.From(...)EtlPipeline.Create().From(...)From is now an instance extension method, so the old static-style call no longer compiles.
  • Replaced the removed EtlPipeline.Source sentinel references with the actual pattern: source factories are extension methods on the EtlPipeline instance (EtlPipeline.Create().CsvExtractor<Order>(...)).
  • New DisposingOwned subsection documenting IEtlPipelineSink.DisposingOwned(...) for factory-owned resource cleanup, with a code sample.

New example

  • Example9-DisposingOwned (net4.8 + net8.0): a pipeline whose sink writes to a caller-opened file, terminated with .DisposingOwned(stream) so the file is closed after RunAsync. The program re-reads the file as proof the stream was disposed.
  • Linked from the new docs section.

Test plan

  • Example9 builds and runs on net8.0 and net4.8 (verified — output writes + re-reads the file, proving disposal; net4.8 exercises the sync IDisposable path).
  • Docs grep clean of stale EtlPipeline.From( / .Source references.
  • CI green.

Targets vNext so it ships in 0.16.0.

🤖 Generated with Claude Code

- Fix stale getting-started/introduction: EtlPipeline.From(...) is now
  EtlPipeline.Create().From(...) (From is an instance extension), and the removed
  EtlPipeline.Source sentinel is replaced with the extension-method description.
- Document IEtlPipelineSink.DisposingOwned for factory-owned resource cleanup.
- Add Example9-DisposingOwned (net4.8 + net8.0): a pipeline whose sink writes to a
  caller-opened file, with DisposingOwned closing it after RunAsync. Verified running
  on both TFMs.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 20, 2026 23:30

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

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.

2 participants