Suppress APIScan documentationnotfound finding for Extensions.Abstractions - #4531
Open
cheenamalhotra wants to merge 3 commits into
Open
Suppress APIScan documentationnotfound finding for Extensions.Abstractions#4531cheenamalhotra wants to merge 3 commits into
cheenamalhotra wants to merge 3 commits into
Conversation
…tions Adds signature ed88d73ca41890d1e3d1e94bb67a93b82ea582c60ac6f496223b89c2da201f62 to the Guardian baseline consumed by globalSdl.baseline.baselineFile in both OneBranch pipelines. This is a temporary suppression pending an upcoming design change. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR suppresses an APIScan documentationnotfound finding for microsoft.data.sqlclient.extensions.abstractions.dll by adding the reported signature to the repo’s Guardian baseline file, aligning with the existing SDL/Guardian baseline workflow used by the OneBranch pipelines.
Changes:
- Added a new APIScan finding signature entry to
.config/guardian/.gdnbaselines. - Included metadata for the new entry (memberOf/default + createdDate) and a justification note.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4531 +/- ##
==========================================
- Coverage 64.84% 62.82% -2.02%
==========================================
Files 288 283 -5
Lines 44092 67410 +23318
==========================================
+ Hits 28590 42349 +13759
- Misses 15502 25061 +9559
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
apoorvdeshmukh
previously approved these changes
Aug 12, 2026
Guardian was looking for a suppression file at its default agent location (<work>/.gdn/.gdnsuppress), which does not exist in this repo, producing: Suppression file expected at ...\.gdn\.gdnsuppress but not found. Adds .config/guardian/.gdnsuppress (alongside the existing baseline and other SDL tool configs) containing the APIScan documentationnotfound signature, and points globalSdl.suppression at it in both the official and non-official OneBranch pipelines. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.
Suppressed comments (3)
eng/pipelines/onebranch/sqlclient-official.yml:186
- The PR description says adding the signature to .gdnbaselines is the supported suppression mechanism and that no .gdnsuppress file is required, but this change wires up an explicit suppressionFile and the PR also adds .config/guardian/.gdnsuppress. Please either (a) update the PR description to reflect the suppressionFile approach, or (b) remove the suppressionFile configuration (and the .gdnsuppress file) to keep the change strictly baseline-only.
suppression:
suppressionFile: $(Build.SourcesDirectory)/.config/guardian/.gdnsuppress
suppressionSet: default
.config/guardian/.gdnbaselines:131
- This new ApiScan signature is being added to the Guardian baseline, but the baseline is described in the pipelines as a snapshot of pre-existing findings. Since this PR also introduces a dedicated suppression file (.gdnsuppress) for post-baseline suppressions, keeping this entry in .gdnbaselines makes the baseline drift and creates redundant suppression paths. Prefer removing this entry from .gdnbaselines and relying on the suppression file instead.
"ed88d73ca41890d1e3d1e94bb67a93b82ea582c60ac6f496223b89c2da201f62": {
"signature": "ed88d73ca41890d1e3d1e94bb67a93b82ea582c60ac6f496223b89c2da201f62",
"alternativeSignatures": [],
"memberOf": [
"default"
eng/pipelines/onebranch/sqlclient-non-official.yml:171
- Same as sqlclient-official.yml: the PR description claims baseline-only suppression with no .gdnsuppress, but this pipeline now configures globalSdl.suppression to point at .config/guardian/.gdnsuppress. Align the PR description and suppression mechanism (baseline-only vs suppressionFile) to avoid confusion for future maintainers.
suppression:
suppressionFile: $(Build.SourcesDirectory)/.config/guardian/.gdnsuppress
suppressionSet: default
Comment on lines
+122
to
+130
| }, | ||
| "ed88d73ca41890d1e3d1e94bb67a93b82ea582c60ac6f496223b89c2da201f62": { | ||
| "signature": "ed88d73ca41890d1e3d1e94bb67a93b82ea582c60ac6f496223b89c2da201f62", | ||
| "alternativeSignatures": [], | ||
| "memberOf": [ | ||
| "default" | ||
| ], | ||
| "justification": "Temporary suppression for ApiScan documentationnotfound in microsoft.data.sqlclient.extensions.abstractions.dll for Microsoft.Data.SqlClient.SqlAuthenticationProviderManager. Remove once the documentation issue is fixed.", | ||
| "createdDate": "2026-08-11 00:00:00Z" |
Contributor
There was a problem hiding this comment.
We're suppressing the same signature (ed88d73c…) twice — here in the baseline, and again in the new .config/guardian/.gdnsuppress. Can we pick one, since this is explicitly a temporary waiver and two locations means two places to remember to clean up.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Suppresses the APIScan
documentationnotfounderror reported againstmicrosoft.data.sqlclient.extensions.abstractions.dllforMicrosoft.Data.SqlClient.SqlAuthenticationProviderManager.Change
Adds the finding signature to
.config/guardian/.gdnbaselines, the Guardian baseline already wired into both OneBranch pipelines viaglobalSdl.baseline.baselineFile. This is the supported suppression mechanism for this repo — no.gdn/.gdnsuppressfile is required (the pipeline is configured to ignore its absence).The entry carries a justification noting this is a temporary suppression pending an upcoming design change, and should be removed once the fix lands.
Checklist