From 2c7527bf7e5b1ff5d2b82511a79e97f91870bd20 Mon Sep 17 00:00:00 2001 From: Yusuke Hayashi Date: Tue, 28 Jul 2026 10:50:47 +0900 Subject: [PATCH] docs: make central site the organization entrypoint --- .gitignore | 2 ++ compatibility.json | 4 ++-- data/ecosystem.toml | 4 ++-- docs/COMPATIBILITY.md | 10 +++++----- profile/README.md | 21 +++++++++++++++++---- profile/README.md.in | 21 +++++++++++++++++---- scripts/export_compatibility.py | 16 ++++++++++++---- tests/test_export_compatibility.py | 29 +++++++++++++++++++++++++++++ 8 files changed, 86 insertions(+), 21 deletions(-) create mode 100644 .gitignore create mode 100644 tests/test_export_compatibility.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..43ae0e2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +__pycache__/ +*.py[cod] diff --git a/compatibility.json b/compatibility.json index 51b5d6d..5a8a349 100644 --- a/compatibility.json +++ b/compatibility.json @@ -177,8 +177,8 @@ }, "foliomcp_ci": { "commit": "a4d110efc223b5774278b21512e176f64f93d525", - "label": "FolioMCP production Workerd CI", - "url": "https://github.com/yhay81/foliomcp-api/actions/runs/30261761976" + "label": "FolioMCP production Workerd CI (private downstream evidence)", + "visibility": "private" }, "golden_app": { "commit": "bc07ff927ce5ca3533f0a006b9000098b9df6e25", diff --git a/data/ecosystem.toml b/data/ecosystem.toml index 907fbb3..efb75b5 100644 --- a/data/ecosystem.toml +++ b/data/ecosystem.toml @@ -37,9 +37,9 @@ url = "https://github.com/hayatepy/hayate-openapi/actions/runs/30261368101" commit = "5d274a7cc337c3336d5316421691779504e592f7" [sources.foliomcp_ci] -label = "FolioMCP production Workerd CI" -url = "https://github.com/yhay81/foliomcp-api/actions/runs/30261761976" +label = "FolioMCP production Workerd CI (private downstream evidence)" commit = "a4d110efc223b5774278b21512e176f64f93d525" +visibility = "private" [sources.ecosystem_full] label = "Hayate 0.15.1 downstream full compatibility CI" diff --git a/docs/COMPATIBILITY.md b/docs/COMPATIBILITY.md index 85a2dc2..928feb0 100644 --- a/docs/COMPATIBILITY.md +++ b/docs/COMPATIBILITY.md @@ -11,9 +11,9 @@ passing CI evidence. Do not edit it manually. The evidence snapshot is dated | [`hayate`](https://github.com/hayatepy/hayate) | `0.15.1` | Core framework and native ASGI, Workers, and Lambda adapters | yes | [golden-app main CI](https://github.com/hayatepy/golden-app/actions/runs/30315193937), [Hayate 0.15.1 downstream full compatibility CI](https://github.com/hayatepy/hayate/actions/runs/30315289736) | | [`hayate-auth`](https://github.com/hayatepy/hayate-auth) | `0.10.1` | Sessions, API keys, OAuth clients, and authorization server | downstream gate | [hayate-auth 0.10.1 main CI](https://github.com/hayatepy/hayate-auth/actions/runs/30271019764), [hayate-auth 0.10.1 security profiles](https://github.com/hayatepy/hayate-auth/actions/runs/30271019713) | | [`hayate-fetch`](https://github.com/hayatepy/hayate-fetch) | `0.1.3` | Portable WHATWG-style outbound fetch | downstream gate | [Hayate 0.15.1 downstream full compatibility CI](https://github.com/hayatepy/hayate/actions/runs/30315289736) | -| [`hayate-mcp`](https://github.com/hayatepy/hayate-mcp) | `0.11.1` | MCP transport, tools, context, and OAuth resource server | yes | [golden-app main CI](https://github.com/hayatepy/golden-app/actions/runs/30315193937), [hayate-mcp 0.11.1 main CI](https://github.com/hayatepy/hayate-mcp/actions/runs/30246879078), [FolioMCP production Workerd CI](https://github.com/yhay81/foliomcp-api/actions/runs/30261761976) | -| [`hayate-openapi`](https://github.com/hayatepy/hayate-openapi) | `0.7.0` | OpenAPI 3.1 generation, Scalar, and typed-client contracts | yes | [golden-app main CI](https://github.com/hayatepy/golden-app/actions/runs/30315193937), [hayate-openapi 0.7.0 main CI](https://github.com/hayatepy/hayate-openapi/actions/runs/30261368101), [FolioMCP production Workerd CI](https://github.com/yhay81/foliomcp-api/actions/runs/30261761976) | -| [`hayate-sql`](https://github.com/hayatepy/hayate-sql) | `0.1.1` | Migration-checked SQL contracts and typed query facades | yes | [golden-app main CI](https://github.com/hayatepy/golden-app/actions/runs/30315193937), [FolioMCP production Workerd CI](https://github.com/yhay81/foliomcp-api/actions/runs/30261761976) | +| [`hayate-mcp`](https://github.com/hayatepy/hayate-mcp) | `0.11.1` | MCP transport, tools, context, and OAuth resource server | yes | [golden-app main CI](https://github.com/hayatepy/golden-app/actions/runs/30315193937), [hayate-mcp 0.11.1 main CI](https://github.com/hayatepy/hayate-mcp/actions/runs/30246879078), FolioMCP production Workerd CI (private downstream evidence) at `a4d110efc223` | +| [`hayate-openapi`](https://github.com/hayatepy/hayate-openapi) | `0.7.0` | OpenAPI 3.1 generation, Scalar, and typed-client contracts | yes | [golden-app main CI](https://github.com/hayatepy/golden-app/actions/runs/30315193937), [hayate-openapi 0.7.0 main CI](https://github.com/hayatepy/hayate-openapi/actions/runs/30261368101), FolioMCP production Workerd CI (private downstream evidence) at `a4d110efc223` | +| [`hayate-sql`](https://github.com/hayatepy/hayate-sql) | `0.1.1` | Migration-checked SQL contracts and typed query facades | yes | [golden-app main CI](https://github.com/hayatepy/golden-app/actions/runs/30315193937), FolioMCP production Workerd CI (private downstream evidence) at `a4d110efc223` | | [`create-hayate`](https://github.com/hayatepy/create-hayate) | `0.11.1` | Composable and production application scaffolds | yes | [golden-app main CI](https://github.com/hayatepy/golden-app/actions/runs/30315193937), [create-hayate 0.11.1 main CI (52/52 backend compositions)](https://github.com/hayatepy/create-hayate/actions/runs/30310444350), [create-hayate 0.11.1 frontend matrix (112/112)](https://github.com/hayatepy/create-hayate/actions/runs/30315312815), [create-hayate 0.11.1 release provenance](https://github.com/hayatepy/create-hayate/actions/runs/30309786799) | ## Runtime contracts @@ -22,7 +22,7 @@ passing CI evidence. Do not edit it manually. The evidence snapshot is dated |---|---|---|---| | Direct | Pure application requests with local SQLite | Golden path | [golden-app main CI](https://github.com/hayatepy/golden-app/actions/runs/30315193937) | | ASGI | Real Uvicorn process with SQLite | Golden path | [golden-app main CI](https://github.com/hayatepy/golden-app/actions/runs/30315193937) | -| Cloudflare Workers class | Real workerd, D1, RPC-capable WorkerEntrypoint, and class handlers | Golden default | [golden-app main CI](https://github.com/hayatepy/golden-app/actions/runs/30315193937), [Hayate 0.15.1 downstream full compatibility CI](https://github.com/hayatepy/hayate/actions/runs/30315289736), [FolioMCP production Workerd CI](https://github.com/yhay81/foliomcp-api/actions/runs/30261761976) | +| Cloudflare Workers class | Real workerd, D1, RPC-capable WorkerEntrypoint, and class handlers | Golden default | [golden-app main CI](https://github.com/hayatepy/golden-app/actions/runs/30315193937), [Hayate 0.15.1 downstream full compatibility CI](https://github.com/hayatepy/hayate/actions/runs/30315289736), FolioMCP production Workerd CI (private downstream evidence) at `a4d110efc223` | | Cloudflare Workers global | Global fetch export without RPC or scheduled class handlers | HTTP-only compatibility mode | [golden-app main CI](https://github.com/hayatepy/golden-app/actions/runs/30315193937) | | AWS Lambda | API Gateway v2 and Function URL buffering plus native response streaming | Core native adapters; outside the golden production flow | [Hayate 0.15.1 main CI](https://github.com/hayatepy/hayate/actions/runs/30314505506) | @@ -58,7 +58,7 @@ Golden lock SHA-256: `519eb20f41eda82058b6798c4494e9154301f28687b9ecce07d8251611 - [hayate-auth 0.10.1 security profiles](https://github.com/hayatepy/hayate-auth/actions/runs/30271019713) at `eff705c335d0903084988edea5b783be258f42e8` - [hayate-mcp 0.11.1 main CI](https://github.com/hayatepy/hayate-mcp/actions/runs/30246879078) at `c1f42c55d47a68fc935460e4a8c07e262a1a7e56` - [hayate-openapi 0.7.0 main CI](https://github.com/hayatepy/hayate-openapi/actions/runs/30261368101) at `5d274a7cc337c3336d5316421691779504e592f7` -- [FolioMCP production Workerd CI](https://github.com/yhay81/foliomcp-api/actions/runs/30261761976) at `a4d110efc223b5774278b21512e176f64f93d525` +- FolioMCP production Workerd CI (private downstream evidence) at `a4d110efc223b5774278b21512e176f64f93d525` - [Hayate 0.15.1 downstream full compatibility CI](https://github.com/hayatepy/hayate/actions/runs/30315289736) at `9e27b0191c7fa9f920ad6fe5b126e190268afba2` - [Hayate 0.15.1 main CI](https://github.com/hayatepy/hayate/actions/runs/30314505506) at `9e27b0191c7fa9f920ad6fe5b126e190268afba2` - [create-hayate 0.11.1 main CI (52/52 backend compositions)](https://github.com/hayatepy/create-hayate/actions/runs/30310444350) at `c3d3f9caf5ff422f508d789e2f3a72b28f363cda` diff --git a/profile/README.md b/profile/README.md index e1a02ce..dfb230a 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,6 +1,17 @@ -# hayatepy +

+ + Hayate + +

+ +# Hayate **Web-standards-first Python for applications that run across ASGI, Cloudflare Workers, and AWS Lambda.** @@ -11,11 +22,13 @@ logic on a conventional Python server or directly inside Cloudflare workerd. ## Start here -1. Follow the [single quickstart](https://github.com/hayatepy/.github/blob/main/docs/START.md). -2. Use the [executable production golden app](https://github.com/hayatepy/golden-app) +1. Read the [unified Hayate documentation](https://hayate-docs.yusuke8h.workers.dev/). +2. [Build the first application](https://hayate-docs.yusuke8h.workers.dev/get-started/first-app/) + on ASGI, native Cloudflare Workers, or AWS Lambda. +3. Use the [executable production golden app](https://github.com/hayatepy/golden-app) for Cloudflare Access, OpenAPI, MCP, checked SQL, operational administration, SQLite/D1, and deployment. -3. Check the [generated compatibility evidence](https://github.com/hayatepy/.github/blob/main/docs/COMPATIBILITY.md) +4. Check the [generated compatibility evidence](https://github.com/hayatepy/.github/blob/main/docs/COMPATIBILITY.md) before selecting versions or runtimes. Building a real API, MCP backend, or Workers application? Help shape the v1 diff --git a/profile/README.md.in b/profile/README.md.in index a72117a..0ccab13 100644 --- a/profile/README.md.in +++ b/profile/README.md.in @@ -1,4 +1,15 @@ -# hayatepy +

+ + Hayate + +

+ +# Hayate **Web-standards-first Python for applications that run across ASGI, Cloudflare Workers, and AWS Lambda.** @@ -9,11 +20,13 @@ logic on a conventional Python server or directly inside Cloudflare workerd. ## Start here -1. Follow the [single quickstart](https://github.com/hayatepy/.github/blob/main/docs/START.md). -2. Use the [executable production golden app](https://github.com/hayatepy/golden-app) +1. Read the [unified Hayate documentation](https://hayate-docs.yusuke8h.workers.dev/). +2. [Build the first application](https://hayate-docs.yusuke8h.workers.dev/get-started/first-app/) + on ASGI, native Cloudflare Workers, or AWS Lambda. +3. Use the [executable production golden app](https://github.com/hayatepy/golden-app) for Cloudflare Access, OpenAPI, MCP, checked SQL, operational administration, SQLite/D1, and deployment. -3. Check the [generated compatibility evidence](https://github.com/hayatepy/.github/blob/main/docs/COMPATIBILITY.md) +4. Check the [generated compatibility evidence](https://github.com/hayatepy/.github/blob/main/docs/COMPATIBILITY.md) before selecting versions or runtimes. Building a real API, MCP backend, or Workers application? Help shape the v1 diff --git a/scripts/export_compatibility.py b/scripts/export_compatibility.py index 55f868d..288eee5 100644 --- a/scripts/export_compatibility.py +++ b/scripts/export_compatibility.py @@ -65,13 +65,21 @@ def _load() -> dict[str, Any]: def _evidence_links(keys: list[str], sources: dict[str, dict[str, str]]) -> str: - return ", ".join( - f"[{sources[key]['label']}]({sources[key]['url']})" for key in keys - ) + references: list[str] = [] + for key in keys: + source = sources[key] + if url := source.get("url"): + references.append(f"[{source['label']}]({url})") + else: + references.append(f"{source['label']} at `{source['commit'][:12]}`") + return ", ".join(references) def _source_line(source: dict[str, str]) -> str: - line = f"- [{source['label']}]({source['url']}) at `{source['commit']}`" + if url := source.get("url"): + line = f"- [{source['label']}]({url}) at `{source['commit']}`" + else: + line = f"- {source['label']} at `{source['commit']}`" if artifact_sha256 := source.get("artifact_sha256"): line += f"; aggregate evidence SHA-256 `{artifact_sha256}`" return line diff --git a/tests/test_export_compatibility.py b/tests/test_export_compatibility.py new file mode 100644 index 0000000..88ad776 --- /dev/null +++ b/tests/test_export_compatibility.py @@ -0,0 +1,29 @@ +from __future__ import annotations + +import sys +import unittest +from pathlib import Path + +sys.path.insert(0, str(Path(__file__).resolve().parents[1] / "scripts")) + +import export_compatibility + + +class ExportCompatibilityTests(unittest.TestCase): + def test_private_evidence_is_plain_text_with_a_commit(self) -> None: + sources = { + "private": { + "label": "Private production gate", + "commit": "0123456789abcdef", + "visibility": "private", + } + } + + rendered = export_compatibility._evidence_links(["private"], sources) + + self.assertEqual(rendered, "Private production gate at `0123456789ab`") + self.assertNotIn("](", rendered) + + +if __name__ == "__main__": + unittest.main()