8000 Add CHANGELOG.md files for Microsoft.Extensions.DataIngestion* projects by Copilot · Pull Request #7072 · dotnet/extensions · GitHub
[go: up one dir, main page]
Skip to content

Add CHANGELOG.md files for Microsoft.Extensions.DataIngestion* projects#7072

Merged
stephentoub merged 4 commits intomainfrom
copilot/create-changelog-files
Nov 24, 2025
Merged

Add CHANGELOG.md files for Microsoft.Extensions.DataIngestion* projects#7072
stephentoub merged 4 commits intomainfrom
copilot/create-changelog-files

Conversation

Copy link
Contributor
Copilot AI commented Nov 21, 2025 •
edited
Loading

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:

  • Explore the DataIngestion projects and understand their public APIs
  • Review PRs merged before Introduce SectionChunker #7015 (merged Nov 10, 2025) to understand initial APIs
  • Create CHANGELOG.md for Microsoft.Extensions.DataIngestion.Abstractions with 10.0.0-preview.1 entry
  • Create CHANGELOG.md for Microsoft.Extensions.DataIngestion with:
  • Create CHANGELOG.md for Microsoft.Extensions.DataIngestion.MarkItDown with 10.0.0-preview.1 entry
  • Create CHANGELOG.md for Microsoft.Extensions.DataIngestion.Markdig with 10.0.0-preview.1 entry
  • Verify CHANGELOG format matches existing patterns in the repository
  • Review and finalize all CHANGELOGs
  • Code review completed
  • Security checks completed
  • Address feedback: Remove internal types (MarkdownParser and ElementsChunker)
  • Simplify to "Initial preview release" format following repository conventions

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.

  1. Microsoft.Extensions.DataIngestion.Abstractions/CHANGELOG.md - Initial preview release
  2. Microsoft.Extensions.DataIngestion/CHANGELOG.md - Initial preview release + SectionChunker in 10.1.0-preview.1 (PR Introduce SectionChunker #7015)
  3. Microsoft.Extensions.DataIngestion.MarkItDown/CHANGELOG.md - Initial preview release
  4. Microsoft.Extensions.DataIngestion.Markdig/CHANGELOG.md - Initial preview release

All CHANGELOGs only document public APIs (internal types excluded) and follow the repository's established conventions for changelog formatting.

Original prompt

This section details on the original issue you should resolve

<issue_title>Create CHANGELOG.md‎ files for Microsoft.Extensions.DataIngestion* projects</issue_title>
<issue_description>For the 10.0.0-preview.1 version, briefly describe every public facing API that was merged before #7015 was merged.

For 10.0.1-preview.1, mention just #7015 for the core Microsoft.Extensions.DataIngestion project</issue_description>

Comments on the Issue (you are @copilot in this section)

💡 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

@adamsitnik
Add CHANGELOG.md files for Microsoft.Extensions.DataIngestion* projects
cb6dd50 
Co-authored-by: adamsitnik <6011991+adamsitnik@users.noreply.github.com>
Copilot AI changed the title [WIP] Add CHANGELOG.md files for DataIngestion projects Add CHANGELOG.md files for Microsoft.Extensions.DataIngestion* projects Nov 21, 2025
Copilot AI requested a review from adamsitnik November 21, 2025 13:09
adamsitnik
adamsitnik reviewed Nov 21, 2025
View reviewed changes
Copy link
Member
@adamsitnik adamsitnik left a 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.

@adamsitnik
Remove internal types from CHANGELOGs (MarkdownParser and ElementsChu…
321b1b4 
…nker)

Co-authored-by: adamsitnik <6011991+adamsitnik@users.noreply.github.com>
Copilot AI requested a review from adamsitnik November 21, 2025 13:25
adamsitnik
adamsitnik approved these changes Nov 21, 2025
View reviewed changes
Copy link
Member
@adamsitnik adamsitnik left a comment

Choose a reason for hiding this comment

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

LGTM!

@stephentoub
Copy link
Member
stephentoub commented Nov 21, 2025

to be honest I am not sure myself, but on the other hand saying that it was just "Initial preview release" is not enough (for me)

Can you elaborate on why? This is a change log. Saying that it's the initial implementation is what changed. It doesn't need to document the full shape of what was added, and frankly I don't think anyone will care, because they look to a change log to understand how various changes impact their previous adoption, and there isn't any.

This is what the other AI library changelogs did, e.g.
image

Subsequent changes can be detailed, covering the diff from the previous source.

Up to you, though.

@stephentoub stephentoub marked this pull request as ready for review November 21, 2025 15:35
Copilot AI review requested due to automatic review settings November 21, 2025 15:35
Copilot AI reviewed Nov 21, 2025
View reviewed changes
Copy link
Contributor
Copilot AI left a comment

Choose a reason for hiding this comment

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

< 10BC0 form class="js-timeline-comment-minimize d-md-inline-block d-flex" data-turbo="false" action="/dotnet/extensions/pull/7072/reviews/3493304327/minimize" accept-charset="UTF-8" method="post">

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 MarkdownParser and ElementsChunker from 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
adamsitnik requested changes Nov 24, 2025
View reviewed changes
Copy link
Member
@adamsitnik adamsitnik left a 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

@dotnet-policy-service dotnet-policy-service bot added the waiting-author-feedback 📭 The author of this issue needs to respond in order for us to continue investigating this issue. label Nov 24, 2025
@adamsitnik
Simplify CHANGELOGs to just "Initial preview release" for 10.0.0-prev…
4c94b4d 
…iew.1

Co-authored-by: adamsitnik <6011991+adamsitnik@users.noreply.github.com>
Copy link
Contributor Author
Copilot AI commented Nov 24, 2025

@copilot please apply my suggestions

Applied all suggestions - simplified to "Initial preview release" format (commit 4c94b4d)

@dotnet-policy-service dotnet-policy-service bot removed the waiting-author-feedback 📭 The author of this issue needs to respond in order for us to continue investigating this issue. label Nov 24, 2025
Copilot AI requested a review from adamsitnik November 24, 2025 13:21
This was referenced Jan 5, 2026
Closed
Closed
Closed
Open
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Merged
Merged
Closed
Closed
Merged
Closed
Closed
Closed
Closed
Open
Closed
Closed
Closed
@github-actions github-actions bot locked and limited conversation to collaborators Jan 9, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

Copilot code review Copilot Copilot left review comments

@stephentoub stephentoub stephentoub approved these changes

+1 more reviewer

@adamsitnik adamsitnik adamsitnik approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@adamsitnik adamsitnik

Copilot code review Copilot

Labels

area-data-ingestion

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Create CHANGELOG.md‎ files for Microsoft.Extensions.DataIngestion* projects

4 participants

@stephentoub @adamsitnik
0