Skip to content

Commit 05a624e

Browse files
docs: refresh roadmap and contributor guidance to current CI state
1 parent 57b615c commit 05a624e

6 files changed

Lines changed: 40 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Before opening or merging a PR, confirm all items below:
2323
Use the repository PR template at `.github/pull_request_template.md` when opening PRs.
2424

2525
- [ ] CI workflows pass on your branch
26+
- [ ] Cross-platform lanes are green for relevant changes (`Build and Test`, `Windows Client EXE Build`, `macOS Client Smoke`)
2627
- [ ] Security checks pass (including CodeQL)
2728
- [ ] Documentation is updated for any behavior/config changes
2829
- [ ] Documentation sync completed when workflows, tests, or security defaults changed
@@ -97,4 +98,7 @@ At minimum, require these checks:
9798
- `Reproducibility Check / Clone Reproducibility`
9899
- `Workflow Action Pin Check / Enforce SHA-Pinned Actions`
99100
- `Governance Check / Governance Integrity`
100-
- Your primary build/test workflow checks
101+
- `Build and Test / build`
102+
- `Windows Client EXE Build / Build Windows Client EXE`
103+
- `macOS Client Smoke / macOS Client Smoke`
104+
- `Observability CI / Validate Dashboard Queries`

Documentation/MASTER_DOCUMENTATION_INDEX.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,12 @@ Current-branch canonical references:
1111
- [Test environment and validation profiles](../tests/docs/TEST_ENV_SETUP.md)
1212
- [Full Validation PR gate workflow](../.github/workflows/full-validation-pr-gate.yml)
1313
- [Full Validation scheduled deep workflow](../.github/workflows/full-validation-scheduled-deep.yml)
14+
- [Observability CI workflow](../.github/workflows/observability-ci.yml)
15+
- [Windows Client EXE Build workflow](../.github/workflows/windows-client-exe.yml)
16+
- [macOS Client Smoke workflow](../.github/workflows/macos-client-smoke.yml)
1417

1518
- Total indexed files: 269
16-
- Indexed on: 2026-04-04 00:00 UTC
19+
- Indexed on: 2026-04-07 00:00 UTC
1720

1821
## Category Index
1922

Documentation/Project/ROADMAP.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,12 @@ This roadmap tracks execution priorities for the current `v1.2.0` platform basel
6060
- Root npm build/test workflow paths corrected to build both SDK packages (`privacy`, `core`) in CI.
6161
- SDK publish and reproducibility workflows aligned to lockfile-driven npm installs.
6262

63+
## Completed in Post-v1.2.0 Reliability Sweep (2026-04)
64+
- Observability CI extended with scheduled drift checks and release-event validation (`published`, `prereleased`).
65+
- Added macOS client smoke workflow for cross-platform client confidence.
66+
- Windows client EXE lane and macOS client smoke lane both validated green on `main` during cross-platform closure.
67+
- Contributor baseline checks re-validated and documented (`npm run test:ci`, Python formatting/lint gates, targeted monitoring tests).
68+
6369
## Next Milestones
6470

6571
### Milestone 1: API and Security Confidence

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ Production-grade federated learning platform that combines Byzantine-resilient a
2626

2727
[![Release](https://img.shields.io/github/v/release/rwilliamspbg-ops/Sovereign_Map_Federated_Learning?display_name=tag&style=flat-square&logo=github)](https://github.com/rwilliamspbg-ops/Sovereign_Map_Federated_Learning/releases)
2828
[![Build and Test](https://github.com/rwilliamspbg-ops/Sovereign_Map_Federated_Learning/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/rwilliamspbg-ops/Sovereign_Map_Federated_Learning/actions/workflows/build.yml)
29+
[![Windows Client EXE Build](https://github.com/rwilliamspbg-ops/Sovereign_Map_Federated_Learning/actions/workflows/windows-client-exe.yml/badge.svg?branch=main)](https://github.com/rwilliamspbg-ops/Sovereign_Map_Federated_Learning/actions/workflows/windows-client-exe.yml)
30+
[![macOS Client Smoke](https://github.com/rwilliamspbg-ops/Sovereign_Map_Federated_Learning/actions/workflows/macos-client-smoke.yml/badge.svg?branch=main)](https://github.com/rwilliamspbg-ops/Sovereign_Map_Federated_Learning/actions/workflows/macos-client-smoke.yml)
2931
[![Observability CI](https://github.com/rwilliamspbg-ops/Sovereign_Map_Federated_Learning/actions/workflows/observability-ci.yml/badge.svg?branch=main)](https://github.com/rwilliamspbg-ops/Sovereign_Map_Federated_Learning/actions/workflows/observability-ci.yml)
3032
[![FedAvg Benchmark Compare](https://github.com/rwilliamspbg-ops/Sovereign_Map_Federated_Learning/actions/workflows/fedavg-benchmark-compare.yml/badge.svg?branch=main)](https://github.com/rwilliamspbg-ops/Sovereign_Map_Federated_Learning/actions/workflows/fedavg-benchmark-compare.yml)
3133
[![API Spec Validation](https://github.com/rwilliamspbg-ops/Sovereign_Map_Federated_Learning/actions/workflows/api-spec-validation.yml/badge.svg?branch=main)](https://github.com/rwilliamspbg-ops/Sovereign_Map_Federated_Learning/actions/workflows/api-spec-validation.yml)
@@ -45,6 +47,22 @@ Documentation entrypoint: [docs/README.md](docs/README.md)
4547

4648
> Canonical docs navigation: [docs/README.md](docs/README.md) for active operator guides and [Documentation/MASTER_DOCUMENTATION_INDEX.md](Documentation/MASTER_DOCUMENTATION_INDEX.md) for full repository documentation indexing.
4749
50+
## Current State Snapshot (April 2026)
51+
52+
- Cross-platform CI coverage is active on `main`.
53+
- Linux lanes: `Build and Test`, `Lint Code Base`, `Reproducibility Check`, `Observability CI`
54+
- Windows lane: `Windows Client EXE Build`
55+
- macOS lane: `macOS Client Smoke`
56+
- Observability CI now runs on push, pull request, scheduled drift checks, and release events (`published`, `prereleased`).
57+
- Current contributor baseline validation commands:
58+
- `npm run test:ci`
59+
- `make observability-smoke`
60+
- `make alerts-test`
61+
- `~/.local/bin/black --check .`
62+
- `~/.local/bin/flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics`
63+
64+
For current roadmap status and remaining open items, see [Documentation/Performance/OPS_OPTIMIZATION_ROADMAP_2026-03-24.md](Documentation/Performance/OPS_OPTIMIZATION_ROADMAP_2026-03-24.md) and [Documentation/Project/ROADMAP.md](Documentation/Project/ROADMAP.md).
65+
4866
## New Contributor Fast Path
4967

5068
If you just cloned the repo and want to run tests quickly, use this sequence.

docs/OPERATIONS_DASHBOARD_METRIC_CONTRACT.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ Static query compatibility:
3535
Live query smoke (requires local compose stack):
3636
- python3 scripts/check_operations_overview_live_queries.py
3737

38+
CI enforcement:
39+
- Workflow: `.github/workflows/observability-ci.yml`
40+
- Triggers: push, pull request, schedule, and release events (`published`, `prereleased`)
41+
3842
Local warmup note:
3943
- Panels 64 and 68 depend on `tpm_node_attestation_latency_ms`, which is only populated after at least one attestation event has been ingested by `tpm-metrics`.
4044
- In a fresh local stack, seed the metric with `/event/attestation` calls or run the dashboard warmup flow before treating those panels as empty.

docs/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ This directory contains the active operator and integration documentation.
2020
- [Test Environment Setup](../tests/docs/TEST_ENV_SETUP.md)
2121
- [Full Validation PR Gate Workflow](../.github/workflows/full-validation-pr-gate.yml)
2222
- [Full Validation Scheduled Deep Workflow](../.github/workflows/full-validation-scheduled-deep.yml)
23+
- [Observability CI Workflow](../.github/workflows/observability-ci.yml)
24+
- [Windows Client EXE Build Workflow](../.github/workflows/windows-client-exe.yml)
25+
- [macOS Client Smoke Workflow](../.github/workflows/macos-client-smoke.yml)
2326

2427
## Roadmaps
2528

0 commit comments

Comments
 (0)