Publishing

Publish a new package version by publishing a GitHub release. You never run dotnet nuget push by hand.

Cut a release

Cut releases by hand with gh release create vX.Y.Z, using the version release-drafter resolves from the merged PR labels. See versioning.

What the workflow does

nuget-publish.yml runs on release: published. It has two jobs:

1. sync-version checks out main, strips the leading v from the release tag, and compares it to <version> in application.properties. If they differ, it:

   1. Edits the file and pushes a release-sync/<version> branch.
   2. Opens a PR labeled CI/CD and skip-changelog.
   3. Auto-merges it with gh pr merge --admin --squash --delete-branch.

   This keeps application.properties, the single source of truth for the package version, in step with the tag.

2. publish (needs: sync-version) checks out main, sets up .NET 10.0.x, packs, signs in to NuGet.org with NuGet/login@v1 and pushes:

   dotnet pack src/Schuly.Plugin.Abstractions/Schuly.Plugin.Abstractions.csproj \
     --configuration Release -o ./out
   dotnet nuget push ./out/*.nupkg \
     --api-key ${{ steps.nuget-login.outputs.NUGET_API_KEY }} \
     --source https://api.nuget.org/v3/index.json \
     --skip-duplicate

   --skip-duplicate makes a re-run safe if the version already exists on NuGet.org.

Trusted Publishing

There is no stored API key. The job has permissions: id-token: write, and NuGet/login trades GitHub's OIDC token for a key that lives about an hour. That only works while the nuget.org policy matches exactly:

Policy field	Value
Package owner	PianoNic
Repository owner and repository	schulydev / SchulyPluginAbstractions
Workflow file	nuget-publish.yml
Environment	none, so the job must not declare environment:
Scope	push new versions of Schuly.Plugin.Abstractions

Renaming the workflow file or the repository breaks publishing until the policy is updated. A re-run of an old release uses the workflow saved at that tag, so cut a new release after changing this file.

Package metadata

Edit metadata in the PropertyGroup of Schuly.Plugin.Abstractions.csproj: PackageId, Description, Authors, PackageProjectUrl, RepositoryUrl, RepositoryType, PackageLicenseExpression (MIT), and PackageTags.

READMEs

The repo has two READMEs:

File	Audience	Notes
README.md (repo root)	GitHub	Centered logo, badges, raw HTML.
src/Schuly.Plugin.Abstractions/NUGET_README.md	NuGet.org	Plain Markdown with absolute image URLs. NuGet.org doesn't render HTML, and relative image paths don't resolve.

The csproj sets <PackageReadmeFile>README.md</PackageReadmeFile> and packs NUGET_README.md as README.md inside the package:

<None Include="NUGET_README.md" Pack="true" PackagePath="README.md" />

So the NuGet page shows NUGET_README.md, and the GitHub repo page shows the root README.md.

Icon

The package icon is assets/app_icon.png, packed as icon.png and set with <PackageIcon>icon.png</PackageIcon>:

<None Include="../../assets/app_icon.png" Pack="true" PackagePath="icon.png" />