Skip to content

Commit 870b887

Browse files
committed
Update public release documentation
1 parent 02c40d1 commit 870b887

2 files changed

Lines changed: 17 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,13 @@ unless `ROAD_VERSION` is set during build.
6161
ROAD zip/checksum files before creating the current version artifacts.
6262
- Added GitHub Actions CI for tests, Windows build smoke, Linux build smoke, and
6363
tag-based release package artifacts.
64+
- Updated GitHub Actions to the Node 24 action generation
65+
(`actions/checkout@v6`, `actions/setup-go@v6`, and
66+
`actions/upload-artifact@v7`) and disabled Go cache restore to avoid noisy
67+
toolchain cache warnings.
68+
- Added public repository hardening after publication: Dependabot security
69+
updates, secret scanning, secret scanning push protection, delete-branch-on-
70+
merge, and `main` branch protection with required CI checks.
6471
- Added repository QA tests that load real config JSON files and built-in plugin
6572
profiles.
6673
- Split the interactive `cmd/road` entrypoint into focused menu, server flow,

docs/PUBLIC-READINESS-AUDIT.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,15 +79,21 @@ Fix: packaging now removes existing `road-proxy-v3_*.zip` and matching `.sha256`
7979
- `trust_proxy_headers=true` is safe only behind Cloudflare or another trusted reverse proxy. Direct exposure with spoofable proxy headers is not supported.
8080
- UDP compatibility remains game-dependent. ROAD can prove transport behavior with `udp-check`, DDNet, and Sven Co-op baselines, but games that embed peer addresses or rely on official Steam/EOS relay traffic may still need protocol-specific work.
8181
- Windows arm64 builds are produced as experimental artifacts and still need runtime testing on real hardware.
82-
- GitHub Release publishing should be verified after tag CI runs in the private repo before flipping visibility to public.
82+
- GitHub Release publishing was verified from tag CI before public release.
83+
- GitHub repository hardening was applied after publication: Dependabot security
84+
updates, secret scanning, secret scanning push protection, delete-branch-on-
85+
merge, and `main` branch protection with required CI checks.
8386

8487
## Public Readiness Verdict
8588

86-
Ready for a private final release run and GitHub Release verification.
89+
Published as a public repository after final CI, release asset, and repository
90+
security verification.
8791

88-
Do not make the repository public until:
92+
Publication checks completed:
8993

9094
1. `go test ./...`, `go vet ./...`, config validation, and release packaging pass after the final commit.
9195
2. The `v0.1.0` tag workflow creates GitHub Release assets successfully.
9296
3. The GitHub Release page contains zip + sha256 assets for Windows amd64, Windows arm64 experimental, Linux amd64, and Linux arm64.
93-
4. Repository visibility, Issues, Discussions, and private vulnerability reporting settings are set intentionally.
97+
4. Repository visibility, Issues, Projects, Wiki, and security settings are set intentionally.
98+
5. `main` branch protection requires `Go Test`, `Linux Build Smoke`, and
99+
`Windows Build Smoke` before merge.

0 commit comments

Comments
 (0)