Skip to content

Release mechanics: PublicAPI promotion, pack/publish pipeline, consumer docs #13

Open

Description

@mgravell

For first release: promote PublicAPI Unshipped→Shipped; NuGet pack/publish pipeline (NBGV already in); consumer-facing README/docs (configuration requirements, degraded modes, divergences from stock, migration notes).

Activity

  1. mgravell commented on Nov 11, 2026

    @mgravell
    MemberAuthor

    Pipeline and consumer docs landed in 1bf0a8e (CI green, including the new pack+validate lane; computed version at that commit: 0.1.20-alpha):

    • release.yml: publishes to nuget.org on GitHub Release via NuGet Trusted Publishing (NuGet/login OIDC + NUGET_USER repo secret, no stored API key); the release tag is verified against the nbgv-computed version; workflow_dispatch is a dry run (pack + validate + run artifact, no push). The release environment exists on the repo.
    • eng/packcheck.cs: grades the nupkg on what nuget.org grades it on (SourceLink at the packed commit, Reproducible entry, embedded portable PDBs, deterministic-mapped sources, readme/icon/license/repository metadata) — runs on every PR/push and again at release. All green locally and in CI.
    • docs/usage.md + README quick-start: configuration (dedicated keyed connection, CacheOptions/tracking, CachePolicy), degraded modes incl. the first-use validation events 1001–1005, options/flags semantics, serialization, telemetry, behavioural notes.

    Remaining for this issue: PublicAPI Unshipped→Shipped promotion, deferred to the first stable release (the surface may still move while the SE.Redis v4 dependency is itself alpha).

    Release runbook: add the NUGET_USER secret + the nuget.org trusted-publishing policy (owner seredis, repo SE.Hybrid, workflow release.yml, environment release), then create a GitHub Release tagged with the version CI's step summary prints.

  2. mgravell commented on Nov 12, 2026

    @mgravell
    MemberAuthor

    Runbook correction — the repo was renamed (seredis/SE.Hybrid → seredis/StackExchange.Redis.HybridCache, commit bdf2257, so the repo matches the package name and the reserved NuGet prefix).

    The nuget.org Trusted Publishing policy must use the new repo name — the OIDC token carries it, and GitHub's redirect does not apply to token claims:

    • Repository Owner: seredis
    • Repository: StackExchange.Redis.HybridCache
    • Workflow File: release.yml
    • Environment: release

    If a policy was already created against SE.Hybrid, edit or recreate it; everything else (the NUGET_USER secret, the release environment, Actions history) survives the rename untouched. Old github.com/seredis/SE.Hybrid links redirect.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions