diff --git a/.github/skills/new-release/SKILL.md b/.github/skills/new-release/SKILL.md index 3e3c66c..8592cda 100644 --- a/.github/skills/new-release/SKILL.md +++ b/.github/skills/new-release/SKILL.md @@ -19,11 +19,53 @@ Versioning is **GitVersion-driven** (`GitVersion.yml`). Do not hand-pick version - Each `src/*` project is versioned **independently**: only changes under that project's own directory, `Directory.Packages.props`, or `GitVersion.yml` increment its version (see `GenerateProjectGitVersionConfig` in `src/Directory.Build.props`, which renders the root `GitVersion.yml` into a per-project copy). A change to one library does not bump a sibling's version. - Increments are suppressed for already-merged branches and already-tagged commits. +## Changelog + +Release notes are generated at pack time and embedded as `PackageReleaseNotes`. The `GenerateChangelogFromGit` target writes `git log` subjects to `$(ChangeLogPath)`, and `CreateReleaseNotesFromFile` reads that file into the nuspec. Both run before `GenerateNuspec`, and generation is skipped when the repository root has no `.git` directory. + +The commit range is resolved in this order, first match wins: + +1. `$(ChangeLogFromRef)..HEAD` — when `ChangeLogFromRef` is set. +2. `..HEAD` — from `git describe --tags --abbrev=0`. +3. `..HEAD` — the last first-parent merge whose subject matches `$(ChangeLogUpstreamMergePattern)`. +4. `..HEAD` — the last first-parent merge. +5. No range; the log is capped at `$(ChangeLogCommitLimit)` commits. + +Commits are filtered with `--no-merges` and scoped to the project's own directory, plus the directories of its `ProjectReference`s unless `ChangeLogIncludeReferences` is `false`. This mirrors the per-project versioning rule above: a sibling library's commits do not appear in this package's notes. + +| Property | Default | Purpose | +| --- | --- | --- | +| `ChangeLogFromRef` | *(empty)* | Explicit range start; overrides the fallback chain | +| `ChangeLogPath` | `$(BaseIntermediateOutputPath)changes.log` | Where the log is written and read from | +| `ChangeLogCommitLimit` | `100` | Cap used only when no range resolves | +| `ChangeLogUpstreamMergePattern` | `from .*/` | Subject matcher for the upstream-merge fallback | +| `ChangeLogIncludeReferences` | `true` | Include `ProjectReference` directories in scoping | +| `GenerateChangelogFromGit` | *(unset)* | Set to `false` to skip generation entirely | + +> [!IMPORTANT] +> Step 2 uses the **nearest reachable** tag, not the newest. Packing from a commit that already carries a release tag therefore yields only the commits added since it — often a single entry. Pass `ChangeLogFromRef` to widen the range: +> +> ```shell +> dotnet pack -c Release -p:ChangeLogFromRef=v4.0.0 +> ``` + +To ship hand-written notes instead, disable generation and point `ChangeLogPath` at your own file. Generation must be disabled, otherwise the target overwrites it: + +```shell +dotnet pack -c Release -p:GenerateChangelogFromGit=false -p:ChangeLogPath=notes.md +``` + +Confirm the resolved range in the build output before publishing: + +```text +Generated changelog at using range v4.0.0..HEAD. +``` + ## Procedure 1. **Sync.** `git fetch --all --tags && git status` — confirm clean. 2. **Compute.** `dotnet build src\\.csproj -getProperty:Version` — verify the value matches expectations for that specific project (there is no single repo-wide version). -3. **Pack.** `dotnet pack -c Release` (or use the [docker-build](../docker-build/SKILL.md) `pack` target). Artifacts land in `artifacts/nuget/`. +3. **Pack.** `dotnet pack -c Release` (or use the [docker-build](../docker-build/SKILL.md) `pack` target). Artifacts land in `artifacts/nuget/`. Check the logged changelog range and pass `ChangeLogFromRef` if it is narrower than the release warrants. 4. **Tag.** `git tag -a v -m "Release v" && git push origin v`. 5. **Publish** packages to the configured feed. 6. **Create the GitHub release** linked to the tag, using the generated changelog as notes.