From bc9d0a7865b1b7ea86fca310774dc5ffd62f7ad8 Mon Sep 17 00:00:00 2001 From: Cole Speelman Date: Mon, 24 Aug 2026 15:17:20 -0400 Subject: [PATCH] docs: move the runnable starter to rc1 --- GENERATED_CODE.md | 4 ++-- README.md | 25 ++++++++++++------------- go.mod | 2 +- go.sum | 4 ++-- scripts/verify.ps1 | 8 ++++---- scripts/verify.sh | 8 ++++---- 6 files changed, 25 insertions(+), 26 deletions(-) diff --git a/GENERATED_CODE.md b/GENERATED_CODE.md index 64f85d9..786e377 100644 --- a/GENERATED_CODE.md +++ b/GENERATED_CODE.md @@ -4,8 +4,8 @@ Every `*.sando.go` file is an owned output of the neighboring `*.sando` source. The committed neighbors were produced by `himesan v1.0.0-beta.1` and remain -byte-current under `himesan v1.0.0-beta.2`; Beta 2 intentionally preserves an -honest producer marker when generated semantics are unchanged. Commit both +byte-current under `himesan v1.0.0-rc.1`; the compiler intentionally preserves +an honest producer marker when generated semantics are unchanged. Commit both files so production builds need only ordinary Go and the small `sando` runtime. Never hand-edit a generated neighbor. Run `himesan generate internal/views`, diff --git a/README.md b/README.md index 4f270b0..19fb54e 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ The starter demonstrates the boundary plainly: time through `Server-Timing`. - Production imports the Apache-2.0 `sando` runtime, not the compiler. -## Walk the path with the Beta 1 runtime and Beta 2 compiler +## Walk the path with RC.1 Install Go 1.25 or newer, then resolve the tiny runtime before installing the immutable classroom compiler: @@ -33,8 +33,8 @@ immutable classroom compiler: ```sh git clone https://gitea.speelman.ca/gamertan/sandwich-hime-tutorial.git cd sandwich-hime-tutorial -GOWORK=off go mod download gamertan.com/sandwich-hime/sando@v1.0.0-beta.1 -go install gamertan.com/sandwich-hime/cmd/himesan@v1.0.0-beta.2 +GOWORK=off go mod download gamertan.com/sandwich-hime/sando@v1.0.0-rc.1 +go install gamertan.com/sandwich-hime/cmd/himesan@v1.0.0-rc.1 ./scripts/verify.sh GOWORK=off go run ./cmd/site ``` @@ -45,8 +45,8 @@ On Windows PowerShell, use the native verifier: git clone https://gitea.speelman.ca/gamertan/sandwich-hime-tutorial.git Set-Location sandwich-hime-tutorial $env:GOWORK = "off" -go mod download gamertan.com/sandwich-hime/sando@v1.0.0-beta.1 -go install gamertan.com/sandwich-hime/cmd/himesan@v1.0.0-beta.2 +go mod download gamertan.com/sandwich-hime/sando@v1.0.0-rc.1 +go install gamertan.com/sandwich-hime/cmd/himesan@v1.0.0-rc.1 .\scripts\verify.ps1 go run ./cmd/site ``` @@ -56,24 +56,23 @@ Make sure Go's install directory—normally `$(go env GOPATH)/bin`—is on verifier. The starter deliberately runs with `GOWORK=off`: it proves the application resolves the published Apache-2.0 runtime rather than a neighboring development checkout. The verification scripts require compiler -`v1.0.0-beta.2` and runtime `v1.0.0-beta.1` exactly. +`v1.0.0-rc.1` and runtime `v1.0.0-rc.1` exactly. If an earlier compiler-first attempt reports that the parent module does not contain `gamertan.com/sandwich-hime/sando`, repair only that module selection: ```sh -GOWORK=off go mod download gamertan.com/sandwich-hime/sando@v1.0.0-beta.1 -GOWORK=off go get gamertan.com/sandwich-hime/sando@v1.0.0-beta.1 +GOWORK=off go mod download gamertan.com/sandwich-hime/sando@v1.0.0-rc.1 +GOWORK=off go get gamertan.com/sandwich-hime/sando@v1.0.0-rc.1 ``` Then run the verifier again. You do not need to clear your whole Go module cache. -The Beta 2 compiler and Beta 1 runtime are intended for classrooms, learning, -prototypes, and evaluation. Their -interfaces may still change before final v1. Linux and Windows have been -maintainer-tested; macOS is provisional while native maintainer testing is -pending. Useful Mac compatibility reports are welcome on canonical Gitea. +RC.1 freezes the intended v1 compiler/runtime contract while public dogfooding +and release-blocking corrections continue. Linux/amd64 and Apple Silicon +macOS/arm64 are maintained native targets. Useful compatibility reports remain +welcome on canonical Gitea. Open [http://127.0.0.1:8080/?name=Hime-san](http://127.0.0.1:8080/?name=Hime-san), refresh it, and watch the request number and UTC time change. Then try: diff --git a/go.mod b/go.mod index cfb19bc..7ca5213 100644 --- a/go.mod +++ b/go.mod @@ -4,4 +4,4 @@ module gitea.speelman.ca/gamertan/sandwich-hime-tutorial go 1.25 -require gamertan.com/sandwich-hime/sando v1.0.0-beta.1 +require gamertan.com/sandwich-hime/sando v1.0.0-rc.1 diff --git a/go.sum b/go.sum index 633c126..55fe96a 100644 --- a/go.sum +++ b/go.sum @@ -1,2 +1,2 @@ -gamertan.com/sandwich-hime/sando v1.0.0-beta.1 h1:WHe6LnVKvOz7CQr9OIWI78pCzIFIAGgoXlGfjYVAVoU= -gamertan.com/sandwich-hime/sando v1.0.0-beta.1/go.mod h1:awOXo4t2zNxxgH60qkTpMOdhYnultm9AfpjlN9gOEis= +gamertan.com/sandwich-hime/sando v1.0.0-rc.1 h1:xXjXkvhD0BQQ+mX/w7zkG7qc0WwVmBqn5yFOq8GUqZQ= +gamertan.com/sandwich-hime/sando v1.0.0-rc.1/go.mod h1:awOXo4t2zNxxgH60qkTpMOdhYnultm9AfpjlN9gOEis= diff --git a/scripts/verify.ps1 b/scripts/verify.ps1 index 91ac419..4232c0a 100644 --- a/scripts/verify.ps1 +++ b/scripts/verify.ps1 @@ -11,10 +11,10 @@ Set-Location $repoRoot $env:GOWORK = "off" $himesan = if ($env:HIMESAN_BIN) { $env:HIMESAN_BIN } else { "himesan" } -$expectedCompilerVersion = "v1.0.0-beta.2" -$expectedRuntimeVersion = "v1.0.0-beta.1" +$expectedCompilerVersion = "v1.0.0-rc.1" +$expectedRuntimeVersion = "v1.0.0-rc.1" if (-not (Get-Command $himesan -ErrorAction SilentlyContinue)) { - throw "himesan was not found; install v1.0.0-beta.2 or set HIMESAN_BIN" + throw "himesan was not found; install v1.0.0-rc.1 or set HIMESAN_BIN" } function Assert-LastExitCode([string]$Step) { @@ -88,4 +88,4 @@ if ($dependencies | Where-Object { $_ -match '^gamertan\.com/sandwich-hime$|^gam throw "production dependency graph contains the Sandwich Hime compiler" } -Write-Output "verified Beta 2 compiler, Beta 1 runtime, deterministic generation, tests, vet, build, and runtime-only production dependencies" +Write-Output "verified RC.1 compiler and runtime, deterministic generation, tests, vet, build, and runtime-only production dependencies" diff --git a/scripts/verify.sh b/scripts/verify.sh index 1d236e4..58f1272 100755 --- a/scripts/verify.sh +++ b/scripts/verify.sh @@ -7,10 +7,10 @@ repo_root=$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd) cd "$repo_root" himesan_bin=${HIMESAN_BIN:-himesan} -expected_compiler_version=v1.0.0-beta.2 -expected_runtime_version=v1.0.0-beta.1 +expected_compiler_version=v1.0.0-rc.1 +expected_runtime_version=v1.0.0-rc.1 if ! command -v "$himesan_bin" >/dev/null 2>&1; then - echo "himesan was not found; install v1.0.0-beta.2 or set HIMESAN_BIN" >&2 + echo "himesan was not found; install v1.0.0-rc.1 or set HIMESAN_BIN" >&2 exit 1 fi @@ -65,4 +65,4 @@ if grep -Eq '^gamertan\.com/sandwich-hime$|^gamertan\.com/sandwich-hime/(cmd|int exit 1 fi -echo "verified Beta 2 compiler, Beta 1 runtime, deterministic generation, tests, vet, build, and runtime-only production dependencies" +echo "verified RC.1 compiler and runtime, deterministic generation, tests, vet, build, and runtime-only production dependencies"