Skip to content

Prepare NuGet package metadata and release workflow#23

Merged
teesofttech merged 1 commit into
mainfrom
feature/8-nuget-package-metadata
Jun 13, 2026
Merged

Prepare NuGet package metadata and release workflow#23
teesofttech merged 1 commit into
mainfrom
feature/8-nuget-package-metadata

Conversation

@teesofttech

@teesofttech teesofttech commented Jun 13, 2026

Copy link
Copy Markdown
Owner

Summary

Adds the missing metadata and release workflow pieces needed before publishing the SDK to NuGet.

What changed

Validation

  • dotnet restore Termii.SDK.sln
  • dotnet build Termii.SDK.sln --configuration Release --no-restore
  • dotnet test tests/Termii.Tests/Termii.Tests.csproj --configuration Release --no-build --logger "trx;LogFileName=unit-tests.trx"
  • dotnet test tests/Termii.IntegrationTests/Termii.IntegrationTests.csproj --configuration Release --no-build --logger "trx;LogFileName=integration-tests.trx"
  • dotnet pack src/Termii/Termii.csproj --configuration Release --no-build --output artifacts/packages

Pack created:

  • Termii.SDK.0.1.0.nupkg
  • Termii.SDK.0.1.0.snupkg

Closes #8

Summary by CodeRabbit

  • New Features

    • Added automated release workflow for publishing the SDK to NuGet.
  • Documentation

    • Updated README with installation instructions and CI build status badge.
    • Added comprehensive release process documentation.
    • Added MIT License information.
    • Updated API coverage tracking for implemented endpoints and features.
  • Chores

    • Configured NuGet package metadata and versioning (v0.1.0).
    • Enhanced CI workflow for artifact handling.

@coderabbitai

coderabbitai Bot commented Jun 13, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 008fbd02-7279-4099-a71d-884a2546b17c

📥 Commits

Reviewing files that changed from the base of the PR and between 8a3f824 and f4e779b.

📒 Files selected for processing (8)
  • .github/workflows/ci.yml
  • .github/workflows/release.yml
  • Directory.Build.props
  • LICENSE
  • README.md
  • docs/API_COVERAGE.md
  • docs/RELEASING.md
  • src/Termii/Termii.csproj

📝 Walkthrough

Walkthrough

This PR adds complete NuGet packaging support to the SDK, including project metadata configuration, build properties, automated release workflow, and comprehensive documentation. The changes enable building, testing, packing, and conditionally publishing the SDK to NuGet.org.

Changes

NuGet Package Publishing Preparation

Layer / File(s) Summary
Project packaging metadata and build properties
src/Termii/Termii.csproj, Directory.Build.props
PackageId changed to Termii.SDK, VersionPrefix set to 0.1.0, and Microsoft.SourceLink.GitHub added. Project file includes README in package root. Build properties enable symbol packaging, license acceptance, repository URL embedding, CI build detection, and source embedding.
Release workflow and CI packaging
.github/workflows/ci.yml, .github/workflows/release.yml
CI artifact upload now includes .snupkg files. New Release workflow triggers on version tags (v*.*.*) and manual dispatch, building in Release mode, running separate unit and integration test steps, packing to artifacts/packages/, uploading artifacts, and conditionally publishing to NuGet when triggered by tag push or manual publish input with NUGET_API_KEY present.
Release documentation, licensing, and project metadata updates
LICENSE, README.md, docs/RELEASING.md, docs/API_COVERAGE.md
MIT License file added with Teesoft Tech copyright. README adds CI badge, package installation command under Usage, and License section. RELEASING.md documents semantic versioning, VersionPrefix alignment, release checklist, and NUGET_API_KEY requirement. API_COVERAGE.md marks CI build/test/packaging and three messaging endpoints as Implemented, NuGet metadata workflow as In progress.

🎯 2 (Simple) | ⏱️ ~12 minutes


🐰 A package hops onto the shelf so bright,
With versioning rules and workflows tight,
CI builds and tests, then off it goes,
To NuGet's home—the SDK flows!
Licensing clear, docs complete with care, ✨📦

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/8-nuget-package-metadata

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@teesofttech
teesofttech marked this pull request as ready for review June 13, 2026 20:46
Copilot AI review requested due to automatic review settings June 13, 2026 20:46
@teesofttech
teesofttech merged commit c8c732c into main Jun 13, 2026
2 of 3 checks passed

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Prepare NuGet package metadata and publishing workflow

2 participants