Skip to content

[7.1.2 Cherry-pick] Add XML documentation validation to OneBranch builds and fix docs issues - #4800

Merged
cheenamalhotra merged 1 commit into
release/7.1from
dev/automation/pr-4730-to-7.1.2
Oct 8, 2026
Merged

cheenamalhotra merged 1 commit into
release/7.1from
dev/automation/pr-4730-to-7.1.2

Conversation

@github-actions

@github-actions github-actions Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

Description

Backports the remaining changes from #4730 to release/7.1 for 7.1.2. Most XML documentation validation infrastructure was already backported in #4752; this PR contains only the additional validator hardening, regression tests, and documentation correction.

  • Reject malformed documentation IDs: empty generic arguments, unbalanced or invalid array suffixes, unmatched/nested/repeated parameter lists, parameter lists on unsupported member kinds, and empty parameters.
  • Preserve valid generic, array, method, indexed-property, and conversion-operator references with regression coverage.
  • Correct the SqlRowUpdatingEventArgs reference to DbDataAdapter.Update(DataSet) from an event (E:) to a method (M:).

Issues

Testing

@github-actions github-actions Bot added this to the 7.1.2 milestone Oct 7, 2026
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
There may be pipelines that require an authorized user to comment /azp run to run.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@paulmedynski
paulmedynski force-pushed the dev/automation/pr-4730-to-7.1.2 branch from 100daed to bf2175b Compare October 7, 2026 11:59
@paulmedynski paulmedynski changed the title [7.1.2 Cherry-pick - CONFLICTS] Add XML documentation validation to OneBranch builds and fix docs issues [7.1.2 Cherry-pick] Add XML documentation validation to OneBranch builds and fix docs issues Oct 7, 2026
@paulmedynski paulmedynski added the Area\Engineering Use this for issues that are targeted for changes in the 'eng' folder or build systems. label Oct 7, 2026
@paulmedynski

Copy link
Copy Markdown
Contributor

/azp run

@paulmedynski
paulmedynski requested a balanced review from Copilot October 7, 2026 12:06
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 2 pipeline(s).

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 review overview

🟡 Changes recommended

The array validation rejects valid dimensions whose lower bound is omitted but size is specified.

Review effort: Balanced
Findings: 1 Medium severity

Open (1)
What changed in this PR

Backports XML documentation validator hardening and corrects an invalid method reference.

Changes:

  • Validates malformed generic, array, and parameter syntax.
  • Adds regression coverage for valid and invalid DocIDs.
  • Corrects the DbDataAdapter.Update(DataSet) cref prefix.
File Description
validate-xml-docs.ps1 Strengthens DocID validation.
validate-xml-docs.Tests.ps1 Adds validator regression tests.
SqlRowUpdatingEventArgs.xml Corrects an event prefix to a method prefix.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread eng/pipelines/onebranch/scripts/validate-xml-docs.ps1
@paulmedynski
paulmedynski marked this pull request as ready for review October 7, 2026 15:42
@paulmedynski
paulmedynski requested a review from a team as a code owner October 7, 2026 15:42
@codecov

codecov Bot commented Oct 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 64.36%. Comparing base (ab3d40a) to head (bf2175b).
⚠️ Report is 1 commits behind head on release/7.1.

Additional details and impacted files
@@               Coverage Diff               @@
##           release/7.1    #4800      +/-   ##
===============================================
- Coverage        66.52%   64.36%   -2.16%     
===============================================
  Files              291      285       -6     
  Lines            45101    68065   +22964     
===============================================
+ Hits             30002    43813   +13811     
- Misses           15099    24252    +9153     
Flag Coverage Δ
CI-SqlClient ?
PR-SqlClient-Project 64.36% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@cheenamalhotra
cheenamalhotra merged commit 932610d into release/7.1 Oct 8, 2026
230 checks passed
@cheenamalhotra
cheenamalhotra deleted the dev/automation/pr-4730-to-7.1.2 branch October 8, 2026 22:38
@github-project-automation github-project-automation Bot moved this from In review to Done in SqlClient Board Oct 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area\Engineering Use this for issues that are targeted for changes in the 'eng' folder or build systems.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants