Skip to content

NUGET_METADATA.md

Latest commit

 

History

History
105 lines (81 loc) · 4.55 KB

NUGET_METADATA.md

File metadata and controls

105 lines (81 loc) · 4.55 KB
Raw

NuGet Metadata

AgentContextKit package metadata is defined in src/AgentContextKit.Cli/AgentContextKit.Cli.csproj.

Current Status

AgentContextKit 0.2.0-alpha.4 is published through the authorized OIDC release workflow. The previous NuGet package version was AgentContextKit 0.2.0-alpha.3.

Shared package metadata:

  • RepositoryUrl is https://github.com/Cynrath/agent-context-kit.
  • PackageProjectUrl is https://github.com/Cynrath/agent-context-kit.
  • Authors is Cynrath.
  • Company is Cynrath.

Publication state:

  • GitHub Actions latest master run is green.
  • GitHub Release page for v0.2.0-alpha.4 is completed as a pre-release.
  • NuGet publish is completed for 0.2.0-alpha.4.
  • NuGet global tool install verification is completed for 0.2.0-alpha.4.
  • Publish SHA: 98cdf9723a509a347bd0403f6373dafe81ba03fb (commit 98cdf97).
  • README.nuget.md package README is shipped with this release.

Previous release state:

  • GitHub Release page for v0.2.0-alpha.2 is completed as a pre-release.
  • NuGet publish is completed for 0.2.0-alpha.2.
  • NuGet global tool install verification is completed for 0.2.0-alpha.2.

The public NuGet owner identity is Cyranth, while package metadata and repository persona use Cynrath. This intentional current-state disposition is documented in docs/NUGET_OWNER_IDENTITY.md; metadata remains Cynrath and no owner mutation is performed.

This review follows Microsoft Learn NuGet package authoring guidance for package ID, version, authors, description, project URL, README, repository metadata, tags, release notes, and license expression:

NuGet README Rendering Contract

The repository intentionally separates the GitHub README and NuGet package README:

  • README.md is the GitHub repository README.
  • README.nuget.md is the NuGet package README.
  • src/AgentContextKit.Cli/AgentContextKit.Cli.csproj owns PackageReadmeFile and the explicit package-root packing entry.

Keep README.nuget.md pure Markdown. Do not add raw HTML, GitHub-only alignment/layout markup, relative local image paths, generated reports, or package artifacts. If nuget.org rendering breaks, edit README.nuget.md and the package metadata/check/docs files together.

A published NuGet version cannot be corrected in place for README rendering. The fix becomes visible on nuget.org only after a later authorized package publish.

Metadata Review

Run report-only mode:

powershell -ExecutionPolicy Bypass -File scripts/check-package-metadata.ps1

Run as a failing gate:

powershell -ExecutionPolicy Bypass -File scripts/check-package-metadata.ps1 -FailOnIssues

With the current package metadata, -FailOnIssues should return exit code 0.

The script is local-only and read-only. It does not pack, push, publish, tag, redact, delete, create remotes, or change package metadata.

Public Install

Install the currently published global tool:

dotnet tool install --global AgentContextKit --version 0.2.0-alpha.4
ackit version
ackit --help

Expected version output:

AgentContextKit 0.2.0-alpha.4

Required Fields

  • PackAsTool: true
  • ToolCommandName: ackit
  • PackageId: AgentContextKit
  • Version: 0.2.0-alpha.4
  • Authors: Cynrath
  • Company: Cynrath
  • PackageReadmeFile: README.nuget.md
  • PackageLicenseExpression: MIT
  • RepositoryType: git
  • RepositoryUrl: https://github.com/Cynrath/agent-context-kit
  • PackageProjectUrl: https://github.com/Cynrath/agent-context-kit
  • PackageRequireLicenseAcceptance: false
  • Description: non-empty
  • PackageTags: includes ai, coding-agent, security, cli, and oss
  • PackageReleaseNotes: non-empty
  • README.nuget.md: present and explicitly packed into the package root

Future Publish Gates

Before future public publish after 0.2.0-alpha.3:

  1. Run scripts/check-package-metadata.ps1 -FailOnIssues.
  2. Run scripts/audit-public-release.ps1 -FailOnIssues.
  3. Run scripts/check-release-blockers.ps1 -FailOnBlockers.
  4. Run scripts/check-public-release-gates.ps1 -FailOnIssues.
  5. Run scripts/verify-release.ps1.
  6. Confirm GitHub Actions latest release run is green.
  7. Confirm the target GitHub Release page is ready.
  8. Publish only after explicit maintainer approval.
  9. Confirm the release.yml provenance probe has been hardened so a missing attestation can lead to actions/attest@v4 instead of failing the publish job.