Skip to content

Commit 9a0f364

Browse files
committed
docs(testing): name the exact file each package-validation property lives in
Addresses Copilot review on #326: the gates table listed both Directory.Build.props and Directory.Build.targets for EnablePackageValidation, but the switch is only in targets — props carries the baseline version. Split the two out and link both files. Also gitignore release-notes.md, the local output of extract-release-notes.sh when previewing a release body.
1 parent de08e83 commit 9a0f364

2 files changed

Lines changed: 4 additions & 1 deletion

File tree

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -401,3 +401,6 @@ FodyWeavers.xsd
401401

402402
# JetBrains Rider
403403
*.sln.iml
404+
405+
# Local output of .github/scripts/extract-release-notes.sh (previewing a release body).
406+
release-notes.md

docs/testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Publishing to NuGet.org is irreversible, so the checks that decide whether a rel
112112

113113
| Gate | Fails on | Where |
114114
|---|---|---|
115-
| Package validation | Any breaking public-API change against the last published version of that package, on any TFM. | `dotnet pack`, via `EnablePackageValidation` in `src/Directory.Build.props` / `Directory.Build.targets` |
115+
| Package validation | Any breaking public-API change against the last published version of that package, on any TFM. | `dotnet pack`. The switch is `EnablePackageValidation` in [`src/Directory.Build.targets`](../src/Directory.Build.targets); the baseline version it compares against is `CelerityPackageValidationBaseline` in [`src/Directory.Build.props`](../src/Directory.Build.props). |
116116
| Package metadata | A missing symbol package, license, README, icon, or SourceLink stamp; a missing or unexpected package id. | [`validate-packages.ps1`](../.github/scripts/validate-packages.ps1) |
117117
| Release notes | No `## [X.Y.Z]` section for the tag, or one at/over the 120,000-byte guard for GitHub's ~125k release-body cap. | [`extract-release-notes.sh`](../.github/scripts/extract-release-notes.sh) |
118118

0 commit comments

Comments
 (0)