dohertj2/mxaccessgw
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs(audit): apply per-cluster judgment fixes across living docs

Browse Source 
Resolve audit findings: correct WorkerEnvelope proto/route/metric/session
facts; rewrite auth (ZB.MOM.WW.Auth migration), dashboard (ZB.MOM.WW.Theme),
and StyleGuide (foreign-project copy-paste); document alarm subsystem, Ldap
options, and gateway alarm broker; fix client CLI flags and package paths.
This commit is contained in:
Joseph Doherty
2026-06-03 16:01:28 -04:00
parent f84e0c3474
commit e541339c07
29 changed files with 1102 additions and 432 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/ClientPackaging.md
+33 -6
View File
@@ -48,8 +48,8 @@ dotnet build src/ZB.MOM.WW.MxGateway.Contracts/ZB.MOM.WW.MxGateway.Contracts.csp
Build and test from the repository root:
```powershell
dotnet build clients/dotnet/ZB.MOM.WW.MxGateway.Client.sln
dotnet test clients/dotnet/ZB.MOM.WW.MxGateway.Client.sln --no-build
dotnet build clients/dotnet/ZB.MOM.WW.MxGateway.Client.slnx
dotnet test clients/dotnet/ZB.MOM.WW.MxGateway.Client.slnx --no-build
```
Create local package artifacts:
@@ -173,10 +173,14 @@ Install, test, and build a wheel from `clients/python`:
Push-Location clients/python
python -m pip install -e ".[dev]"
python -m pytest
python -m pip wheel . --no-deps --wheel-dir "$env:TEMP\mxgateway-python-wheel"
python -m build --outdir "$env:TEMP\mxgateway-python-dist"
Pop-Location
```
`python -m build` (sdist plus wheel) is the canonical build method — it is what
`scripts/pack-clients.ps1` runs for the Python package. Use
`python -m pip wheel . --no-deps` only for a quick wheel-only build.
Run the CLI from the editable install or with `python -m`:
```powershell
@@ -190,9 +194,10 @@ Pop-Location
## Java
The Java workspace uses Gradle, Java 21, `mxgateway-client`, and
`mxgateway-cli`. The Gradle protobuf plugin writes generated Java protobuf and
gRPC sources under `clients/java/src/main/generated`.
The Java workspace uses Gradle, Java 21, and the subprojects
`zb-mom-ww-mxgateway-client` and `zb-mom-ww-mxgateway-cli`. The Gradle protobuf
plugin writes generated Java protobuf and gRPC sources under
`clients/java/src/main/generated`.
Regenerate Java bindings:
@@ -228,6 +233,28 @@ gradle :zb-mom-ww-mxgateway-cli:run --args="smoke --endpoint mxgateway.example.l
Pop-Location
```
## Packing All Clients
`scripts/pack-clients.ps1` runs every client's native packaging command and
drops the artifacts into one directory so a release does not depend on running
each per-language command by hand. It packs the .NET NuGet packages
(`ZB.MOM.WW.MxGateway.Contracts` and `ZB.MOM.WW.MxGateway.Client`), the Python
sdist and wheel (`python -m build`), the Rust `.crate` (`cargo package`), and
the Java jars plus generated POM (`gradle assemble` and the publication tasks).
Go has no artifact to pack — it is released by git-tagging, so the script prints
the `scripts/tag-go-module.ps1` command and skips it.
```powershell
pwsh scripts/pack-clients.ps1
pwsh scripts/pack-clients.ps1 -Languages dotnet,python
```
Artifacts land in `-OutputDir` (default `dist/`). Each language runs its
regression tests first unless `-SkipTests` is set. With `-Publish`, every
package is pushed to the internal Gitea feed; this requires the `GITEA_USERNAME`
and `GITEA_TOKEN` environment variables and the script refuses to publish if
either is missing.
## Integration Tests
Client integration checks are opt-in because they need a live gateway and a