-
Notifications
You must be signed in to change notification settings - Fork 845
Add CHANGELOG.md files for Microsoft.Extensions.DataIngestion* projects #7072
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Co-authored-by: adamsitnik <6011991+adamsitnik@users.noreply.github.com>
src/Libraries/Microsoft.Extensions.DataIngestion.Abstractions/CHANGELOG.md
Outdated
Show resolved
Hide resolved
adamsitnik
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot It looks great, we just need two minor corrections.
src/Libraries/Microsoft.Extensions.DataIngestion.Markdig/CHANGELOG.md
Outdated
Show resolved
Hide resolved
src/Libraries/Microsoft.Extensions.DataIngestion.Abstractions/CHANGELOG.md
Outdated
Show resolved
Hide resolved
…nker) Co-authored-by: adamsitnik <6011991+adamsitnik@users.noreply.github.com>
adamsitnik
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds CHANGELOG.md files for the four Microsoft.Extensions.DataIngestion* projects to document their initial public-facing APIs. The CHANGELOGs follow the repository's established format and document all public APIs introduced in the 10.0.0-preview.1 release, with the core DataIngestion project also documenting the SectionChunker addition from 10.1.0-preview.1 (PR #7015).
Key changes:
- Documents public APIs for the DataIngestion abstractions, core implementations, and two reader packages
- Correctly excludes internal types like
MarkdownParserandElementsChunkerfrom documentation - Follows the repository's CHANGELOG format and conventions
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/Libraries/Microsoft.Extensions.DataIngestion/CHANGELOG.md | Documents core library APIs including pipeline, chunkers, enrichers, and vector store writer across two versions (10.0.0-preview.1 and 10.1.0-preview.1) |
| src/Libraries/Microsoft.Extensions.DataIngestion.Abstractions/CHANGELOG.md | Documents all abstraction types including IngestionDocument, IngestionChunk, base classes for chunkers/readers/processors/writers, and document element types |
| src/Libraries/Microsoft.Extensions.DataIngestion.MarkItDown/CHANGELOG.md | Documents MarkItDownReader and MarkItDownMcpReader classes for converting documents via MarkItDown tool and MCP server |
| src/Libraries/Microsoft.Extensions.DataIngestion.Markdig/CHANGELOG.md | Documents MarkdownReader class for reading markdown documents |
adamsitnik
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot please apply my suggestions
src/Libraries/Microsoft.Extensions.DataIngestion.Abstractions/CHANGELOG.md
Outdated
Show resolved
Hide resolved
src/Libraries/Microsoft.Extensions.DataIngestion.Markdig/CHANGELOG.md
Outdated
Show resolved
Hide resolved
src/Libraries/Microsoft.Extensions.DataIngestion.MarkItDown/CHANGELOG.md
Outdated
Show resolved
Hide resolved
…iew.1 Co-authored-by: adamsitnik <6011991+adamsitnik@users.noreply.github.com>
adamsitnik
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
![]()
@stephentoub I've removed these descriptions. I was just not used to the concept of change log and tried to add part of the docs in the wrong place. PTAL |

Create CHANGELOG.md files for Microsoft.Extensions.DataIngestion* projects ✅
Successfully created CHANGELOG.md files for all 4 DataIngestion projects following the repository's simplified changelog format for initial preview releases.
Completed:
Summary:
All four CHANGELOG files follow the simplified format used by other libraries in the repository (e.g., AI libraries), with just "Initial preview release" for version 10.0.0-preview.1. This approach aligns with changelog best practices where initial releases are kept simple, and subsequent changes provide detailed diffs from previous versions.
All CHANGELOGs only document public APIs (internal types excluded) and follow the repository's established conventions for changelog formatting.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.
Microsoft Reviewers: Open in CodeFlow