chore: release 0.1.0-alpha : Trusted Publishing workflow, CHANGELOG, pack dry-run tooling - #20
Merged
Merged
Conversation
…uring README presence
…o changelog and publishing steps
…ady-state release process
…packages, and known limitations
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Release plumbing for the first NuGet cut. All code for 0.1.0-alpha is already in
main— this branch adds the mechanics to ship it via NuGet Trusted Publishing (OIDC), no long-lived API key.What's new
.github/workflows/release.ymlTag-triggered release pipeline: fires on
v[0-9]+.[0-9]+.[0-9]+*push. Steps:dotnet pack shelldocs.slnx→ 6.nupkg+ 6.snupkgsymbol packagesNuGet/login@v1— exchanges GitHub OIDC token for a 1-hour NuGet API key--skip-duplicate(re-runs are safe)Includes
workflow_dispatchwithdry_run: true(default) for pack-and-validate runs that skip the NuGet push.Trusted Publishing posture — no
NUGET_API_KEYsecret in the repo. Job declaresenvironment: release+permissions: id-token: write; the NuGet login action verifies GitHub's OIDC token against a policy registered on nuget.org (pinned to ownershellui-dev/ reposhelldocs/ workflowrelease.yml/ environmentrelease). Blast radius = this specific workflow file in this specific repo. Rotation burden = zero. Verified against Microsoft's live docs.CHANGELOG.mdKeep-a-Changelog format. Full
[0.1.0-alpha] — 2026-07-25entry lists all six packages and every shipped feature: content primitives, API-reference primitives, chrome, auto-chrome viaDocsPageState, search with body-text indexing, consumer DX (assembly-scan registration, aliases, brand logo, package selector), animation polish, CLI commands. Also documents known limitations for the alpha window.docs/RELEASING.mdFull runbook. One-time setup covers: package-ID availability check,
releaseGitHub environment creation, Trusted Publishing policy registration on nuget.org (with exact field names from the current docs —Repository Owner,Repository,Workflow Filefilename-only,Environment),NUGET_USERenvironment secret. Steady-state section reduces subsequent releases to three commands: bumpDirectory.Build.props, update CHANGELOG, tag + push.scripts/pack-dry-run.ps1+scripts/pack-dry-run.shLocal pack into
./nupkgs-dryrun/, extract each.nupkg, verify README embed, printid + version + sizefor eyeball check. Fails loud on missing README. Ran successfully during branch prep:Changed
README.md— status line updated to reflect the shipping state, links toCHANGELOGanddocs/RELEASING.md.Pre-merge configuration already done on GitHub + NuGet
releaseenvironment created in repo Settings → Environments; deployment restricted tov*.*.*tag pushes;NUGET_USERset as environment secret (nuget.org profile name)ShellDocs.CLI/.Components/.Core/.Markdown/.Templates/.Tokensall verified free on nuget.orgshellui-dev, reposhelldocs, workflowrelease.yml, environmentreleaseTest plan
dotnet build shelldocs.slnx— clean, 0 warnings, 0 errorsdotnet test shelldocs.slnx— 139 / 139 passingbash scripts/pack-dry-run.sh— all six packages pack + validate; README embedded in each; correct 0.1.0-alpha version fromDirectory.Build.propsNuGet/login@v1), permissions (id-token: write+contents: write), output name (NUGET_API_KEY), and TP policy field names verified against Microsoft's current live docsPost-merge — cut the release