Issue #50: document client packaging #100

Merged
dohertj2 merged 3 commits from agent-2/issue-50-client-packaging-documentation into main 2026-04-26 21:28:48 -04:00
Owner

Closes #50.

Summary:

  • Adds docs/ClientPackaging.md with clean-checkout build, generation, packaging, CLI, TLS/API key, and integration-smoke commands for .NET, Go, Rust, Python, and Java clients.
  • Updates each client README with package/install, regeneration, TLS/API key, and integration check guidance.
  • Links the new packaging guide from shared client docs and records the generated-code command for every language.

Verification:

  • scripts/publish-client-proto-inputs.ps1 -Check
  • scripts/validate-client-behavior-fixtures.ps1
  • dotnet build src/MxGateway.Contracts/MxGateway.Contracts.csproj
  • dotnet build clients/dotnet/MxGateway.Client.sln
  • dotnet test clients/dotnet/MxGateway.Client.sln --no-build
  • dotnet pack clients/dotnet/MxGateway.Client/MxGateway.Client.csproj -c Release -p:PackageOutputPath=...
  • dotnet publish clients/dotnet/MxGateway.Client.Cli/MxGateway.Client.Cli.csproj -c Release -o artifacts/clients/dotnet/mxgw-dotnet
  • Go generation, test, build, vet, package build, and CLI version using documented tool path
  • Rust fmt, test, check, release build, and CLI version using documented tool path
  • python -m pip install -e ".[dev]", python -m pytest, Python wheel build, and CLI version
  • Java generateProto, test, jar/installDist, and CLI version using documented Gradle path
Closes #50. Summary: - Adds `docs/ClientPackaging.md` with clean-checkout build, generation, packaging, CLI, TLS/API key, and integration-smoke commands for .NET, Go, Rust, Python, and Java clients. - Updates each client README with package/install, regeneration, TLS/API key, and integration check guidance. - Links the new packaging guide from shared client docs and records the generated-code command for every language. Verification: - `scripts/publish-client-proto-inputs.ps1 -Check` - `scripts/validate-client-behavior-fixtures.ps1` - `dotnet build src/MxGateway.Contracts/MxGateway.Contracts.csproj` - `dotnet build clients/dotnet/MxGateway.Client.sln` - `dotnet test clients/dotnet/MxGateway.Client.sln --no-build` - `dotnet pack clients/dotnet/MxGateway.Client/MxGateway.Client.csproj -c Release -p:PackageOutputPath=...` - `dotnet publish clients/dotnet/MxGateway.Client.Cli/MxGateway.Client.Cli.csproj -c Release -o artifacts/clients/dotnet/mxgw-dotnet` - Go generation, test, build, vet, package build, and CLI version using documented tool path - Rust fmt, test, check, release build, and CLI version using documented tool path - `python -m pip install -e ".[dev]"`, `python -m pytest`, Python wheel build, and CLI version - Java generateProto, test, jar/installDist, and CLI version using documented Gradle path
dohertj2 added 1 commit 2026-04-26 21:23:17 -04:00
dohertj2 added 2 commits 2026-04-26 21:28:19 -04:00
dohertj2 merged commit 6ce61a4f77 into main 2026-04-26 21:28:48 -04:00
Sign in to join this conversation.