Skip to content

Minor touch-ups to BuildGuide and build.proj#4246

Open
cheenamalhotra wants to merge 8 commits intomainfrom
dev/cheena/minor-fixes
Open

Minor touch-ups to BuildGuide and build.proj#4246
cheenamalhotra wants to merge 8 commits intomainfrom
dev/cheena/minor-fixes

Conversation

@cheenamalhotra
Copy link
Copy Markdown
Member

@cheenamalhotra cheenamalhotra commented Apr 29, 2026

Nothing major - fixing few typos and adding some details.

Also fixes build error when building SqlClient with below command:

dotnet build build.proj -t:BuildSqlClient,PackSqlClient -p:BuildSuffix=docs

Failed Build

Error:

PackSqlClient:
  >>> Fetching latest git commit hash via command:  git rev-parse HEAD 
   git rev-parse HEAD 
  3af6e09257eedd607f445c5647cf62550bb8aee9
  >>> Evaluating SqlClient package version via command:  "dotnet" msbuild "D:\a\_work\1\s\src\..\src/Microsoft.Data.SqlClient/src/Microsoft.Data.SqlClient.csproj" -nologo -verbosity:quiet -getProperty:SqlClientPackageVersion -p:BuildNumber=0 -p:BuildSuffix=docs 
   "dotnet" msbuild "D:\a\_work\1\s\src\..\src/Microsoft.Data.SqlClient/src/Microsoft.Data.SqlClient.csproj" -nologo -verbosity:quiet -getProperty:SqlClientPackageVersion -p:BuildNumber=0 -p:BuildSuffix=docs 
  7.1.0-preview1-docs
  >>> Packing SqlClient nuget via command:  "nuget" pack "D:\a\_work\1\s\src\..\tools/specs/Microsoft.Data.SqlClient.nuspec" -Symbols -SymbolPackageFormat snupkg -Version "7.1.0-preview1-docs" -OutputDirectory "D:\a\_work\1\s\src\..\artifacts/Microsoft.Data.SqlClient//Project-Release" -properties "COMMITID=3af6e09257eedd607f445c5647cf62550bb8aee9;Configuration=Release;ReferenceType=Project;AbstractionsPackageVersion=;LoggingPackageVersion=" 
   "nuget" pack "D:\a\_work\1\s\src\..\tools/specs/Microsoft.Data.SqlClient.nuspec" -Symbols -SymbolPackageFormat snupkg -Version "7.1.0-preview1-docs" -OutputDirectory "D:\a\_work\1\s\src\..\artifacts/Microsoft.Data.SqlClient//Project-Release" -properties "COMMITID=3af6e09257eedd607f445c5647cf62550bb8aee9;Configuration=Release;ReferenceType=Project;AbstractionsPackageVersion=;LoggingPackageVersion=" 
  Attempting to build package from 'Microsoft.Data.SqlClient.nuspec'.
  An error occured while trying to parse the value '' of property 'dependencies' in the manifest file.
    '' is not a valid version string.
##[error]build.proj(590,5): Error MSB3073: The command " "nuget" pack "D:\a\_work\1\s\src\..\tools/specs/Microsoft.Data.SqlClient.nuspec" -Symbols -SymbolPackageFormat snupkg -Version "7.1.0-preview1-docs" -OutputDirectory "D:\a\_work\1\s\src\..\artifacts/Microsoft.Data.SqlClient//Project-Release" -properties "COMMITID=3af6e09257eedd607f445c5647cf62550bb8aee9;Configuration=Release;ReferenceType=Project;AbstractionsPackageVersion=;LoggingPackageVersion=" " exited with code 1.
D:\a\_work\1\s\build.proj(590,5): error MSB3073: The command " "nuget" pack "D:\a\_work\1\s\src\..\tools/specs/Microsoft.Data.SqlClient.nuspec" -Symbols -SymbolPackageFormat snupkg -Version "7.1.0-preview1-docs" -OutputDirectory "D:\a\_work\1\s\src\..\artifacts/Microsoft.Data.SqlClient//Project-Release" -properties "COMMITID=3af6e09257eedd607f445c5647cf62550bb8aee9;Configuration=Release;ReferenceType=Project;AbstractionsPackageVersion=;LoggingPackageVersion=" " exited with code 1.
Done Building Project "D:\a\_work\1\s\build.proj" (BuildSqlClient;PackSqlClient target(s)) -- FAILED.

Build FAILED.

Changes verified: Fixed Build

@cheenamalhotra cheenamalhotra requested a review from a team as a code owner April 29, 2026 01:11
Copilot AI review requested due to automatic review settings April 29, 2026 01:11
@github-project-automation github-project-automation Bot moved this to To triage in SqlClient Board Apr 29, 2026
@cheenamalhotra cheenamalhotra added this to the 7.1.0-preview2 milestone Apr 29, 2026
Copy link
Copy Markdown
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.

Pull request overview

Updates the build guide documentation to correct a typo and clarify usage of the PackageVersion<TargetPackage> MSBuild parameter for build.proj.

Changes:

  • Fixes the -p:PackageVersion<TargetPackage> table row formatting/typo.
  • Adds a list of accepted <TargetPackage> suffixes in the build guide.

Comment thread BUILDGUIDE.md Outdated
cheenamalhotra and others added 2 commits April 28, 2026 18:14
Co-authored-by: Copilot <copilot@github.com>
Copilot AI review requested due to automatic review settings April 29, 2026 01:17
Copy link
Copy Markdown
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.

Pull request overview

Updates build tooling documentation and fixes a property wiring issue so package version parameters behave as documented.

Changes:

  • Fix PackageVersionAzureArgument to pass $(PackageVersionAzure) into AzurePackageVersion.
  • Clean up BUILDGUIDE wording/casing/typos and expand the PackageVersion<TargetPackage> documentation.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
build.proj Corrects the Azure package-version argument wiring so PackageVersionAzure actually takes effect.
BUILDGUIDE.md Improves wording/typos and adds details around package version parameters and packing guidance.

Comment thread BUILDGUIDE.md Outdated
Comment thread BUILDGUIDE.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 29, 2026 01:20
Copy link
Copy Markdown
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.

Pull request overview

Updates build/versioning wiring and polishes the developer build documentation to better reflect the supported build.proj parameters and workflows.

Changes:

  • Fixes PackageVersionAzureArgument in build.proj to pass $(PackageVersionAzure) to AzurePackageVersion.
  • Corrects multiple typos/wording issues and improves clarity in BUILDGUIDE.md (prereqs, packaging section, and versioning notes).
  • Expands documentation for -p:PackageVersion<TargetPackage> to enumerate valid target package names.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
build.proj Corrects the Azure package version property wiring so PackageVersionAzure actually affects AzurePackageVersion.
BUILDGUIDE.md Fixes typos and refines build/pack documentation, including the PackageVersion<…> parameter description.

Comment thread BUILDGUIDE.md
Co-authored-by: Copilot <copilot@github.com>
@cheenamalhotra cheenamalhotra moved this from To triage to In review in SqlClient Board Apr 29, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 29, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 64.25%. Comparing base (771b16c) to head (7b76864).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4246      +/-   ##
==========================================
- Coverage   65.95%   64.25%   -1.71%     
==========================================
  Files         277      272       -5     
  Lines       42989    65783   +22794     
==========================================
+ Hits        28354    42269   +13915     
- Misses      14635    23514    +8879     
Flag Coverage Δ
CI-SqlClient ?
PR-SqlClient-Project 64.25% <ø> (?)

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

☔ View full report in Codecov by Sentry.
📢 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.

Copilot AI review requested due to automatic review settings April 29, 2026 02:41
@cheenamalhotra cheenamalhotra changed the title Minor touch-ups to BuildGuide Minor touch-ups to BuildGuide and build.proj Apr 29, 2026
Copy link
Copy Markdown
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.

Pull request overview

Updates build/pack infrastructure and build documentation to better align version parameters and reduce friction when packing SqlClient without explicitly specifying dependency package versions.

Changes:

  • Fix PackageVersionAzureArgument to pass $(PackageVersionAzure) (not $(PackageVersionAbstractions)).
  • In PackSqlClient, auto-evaluate PackageVersionAbstractions / PackageVersionLogging from their projects when not provided, and pass them into nuget pack.
  • Clean up BUILDGUIDE.md typos and clarify PackageVersion<TargetPackage> usage + examples.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
build.proj Fixes Azure version argument wiring; adds PackSqlClient-time evaluation/sanitization of Abstractions/Logging package versions for nuspec dependency properties.
BUILDGUIDE.md Typo/wording fixes; documents correct PackageVersion<...> parameters and updates examples accordingly.

Comment thread BUILDGUIDE.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In review

Development

Successfully merging this pull request may close these issues.

3 participants