Please note we can't commit to any timeline.
Describe the bug 🐞
The release workflow invokes GitReleaseNoteGenerator without --head-ref. Its default is the repository default branch, not the publishing commit. Release-branch notes can include main-only changes; even main releases can race a later push.
Step to reproduce
Execute the actual git-release-notes command from .github/workflows/release.yml with GITHUB_SHA set to the publishing commit. Capture CLI arguments with a stub function, without publishing anything.
Regression tests/checks:
.github/scripts/Test-ReleaseNotesInvocation.ps1
Reproduction repository
https://github.com/reactivemarbles/DynamicData/tree/85ee49cfd54d8782c36ed137886d318e942345c4
Regression tests and fixes:
https://github.com/reactivemarbles/DynamicData/tree/u/dacullop/main/pr-1165-review
Expected behavior
The generator must receive --head-ref with GITHUB_SHA, alongside the intended release version and output file.
Screenshots 🖼️
N/A.
IDE
N/A; command-line reproduction.
Operating system
Windows.
Version
.NET SDK 10.0.401; net9.0 test target.
Device
N/A.
DynamicData Version
Main 10.0-preview at 85ee49c. The related 9.5 candidate is PR #1165 at 3d76872.
Additional information ℹ️
Before the fix, the actual command fails the contract test: Release notes must compare against the commit being published, not the repository default branch. It passes after the explicit head argument is added.
Please note we can't commit to any timeline.
Describe the bug 🐞
The release workflow invokes GitReleaseNoteGenerator without --head-ref. Its default is the repository default branch, not the publishing commit. Release-branch notes can include main-only changes; even main releases can race a later push.
Step to reproduce
Execute the actual git-release-notes command from .github/workflows/release.yml with GITHUB_SHA set to the publishing commit. Capture CLI arguments with a stub function, without publishing anything.
Regression tests/checks:
Reproduction repository
https://github.com/reactivemarbles/DynamicData/tree/85ee49cfd54d8782c36ed137886d318e942345c4
Regression tests and fixes:
https://github.com/reactivemarbles/DynamicData/tree/u/dacullop/main/pr-1165-review
Expected behavior
The generator must receive --head-ref with GITHUB_SHA, alongside the intended release version and output file.
Screenshots 🖼️
N/A.
IDE
N/A; command-line reproduction.
Operating system
Windows.
Version
.NET SDK 10.0.401; net9.0 test target.
Device
N/A.
DynamicData Version
Main 10.0-preview at 85ee49c. The related 9.5 candidate is PR #1165 at 3d76872.
Additional information ℹ️
Before the fix, the actual command fails the contract test: Release notes must compare against the commit being published, not the repository default branch. It passes after the explicit head argument is added.