Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/baseline.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ jobs:
# names a packageManager, and then fails on a runner with no pnpm.
# This job installs nothing.
package-manager-cache: false
- name: Contract tests (manifest, phases, coverage, rebrand, retouch, bootstrap-defer)
- name: Contract tests (manifest, phases, coverage, rebrand, retouch, bootstrap-defer, render)
run: |
set -euo pipefail
python3 -c 'import yaml' 2>/dev/null || pip install --quiet pyyaml
for t in manifest phases coverage rebrand retouch bootstrap-defer; do
for t in manifest phases coverage rebrand retouch bootstrap-defer render; do
echo "── $t"
bash "testing/$t.test.sh"
done
Expand Down
36 changes: 33 additions & 3 deletions hooks/render-deployment-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,46 @@ badge() { case "$1" in 2*|3*) echo "LIVE ($1)" ;; 000) echo "unreachable" ;; *)

# The environment's public origin: SITE_URL from intent.yaml when set (a custom
# domain the owner attached), else the workers.dev URL.
# STANDARD LIBRARY ONLY. The build box has python3 but not PyYAML, and an
# `import yaml` that fails ended this hook with exit 1 and no message:
# console builds reached 03-docs and stopped here, with the site live.
# PyYAML is used when present; otherwise the one key this needs is read by
# indentation: environments → <env> → env → SITE_URL.
site_url() {
python3 - "$1" "https://${brand}-web-$1.${sub}.workers.dev" <<'PY'
import sys, yaml
import re, sys
env, fallback = sys.argv[1], sys.argv[2]

def by_indent(text):
path, want = [], ["environments", env, "env", "SITE_URL"]
for line in text.splitlines():
if not line.strip() or line.lstrip().startswith("#"):
continue
m = re.match(r"^( *)([A-Za-z0-9_.-]+):(.*)$", line)
if not m:
continue
depth = len(m.group(1))
while path and path[-1][0] >= depth:
path.pop()
path.append((depth, m.group(2)))
if [k for _, k in path] == want:
value = m.group(3).split(" #")[0].strip()
return value.strip("'\"")
return ""

try:
text = open("intent.yaml").read()
except OSError:
text = ""
try:
d = yaml.safe_load(open("intent.yaml")) or {}
import yaml
d = yaml.safe_load(text) or {}
url = (((d.get("environments") or {}).get(env) or {}).get("env") or {}).get("SITE_URL") or ""
except ImportError:
url = by_indent(text)
except Exception:
url = ""
print(url.rstrip("/") or fallback)
print(str(url).rstrip("/") or fallback)
PY
}
stage_url="$(site_url stage)"; prod_url="$(site_url prod)"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@
| NG-E | The template's component-style budget warns | ACCEPTED | The welcome page's inline `<style>` is 3.76 kB against the template's own 2 kB `anyComponentStyle` warning budget; `ng build` warns and succeeds, as the template's budgets say. A product replacing the page clears it |
| NG-F | stack-tectonic 0.19.0, not 0.20.0 | ACCEPTED | 0.20.0's lane-shared install links each job's `node_modules` out of its tree; the siblings pin 0.19.0 for it and the app would save nothing |
| NG-G | zone.js kept | ACCEPTED | The template ran on zone.js; Angular 22 generates zoneless apps by default. `provideZoneChangeDetection()` keeps the template's behaviour; dropping zone.js is the owner's change |
| NG-H | 03-docs needs PyYAML the build box lacks | RESOLVED | `hooks/render-deployment-docs.sh` imported `yaml` to read the public origin from `intent.yaml`. The build box has python3 but not PyYAML, so the import failed with exit 1 and no message, and console builds stopped at 03-docs with the site live. Local and CLI runs had PyYAML and passed. blog-starter (BS-H), astro-boilerplate (AB-L) and portfolio-starter-kit (PK-L) hit it first (2026-11-06). The hook now uses PyYAML when present and reads that one key by indentation otherwise; `testing/render.test.sh` runs it under a python3 with no third-party packages |
51 changes: 51 additions & 0 deletions testing/render.test.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
#!/usr/bin/env bash
# hooks/render-deployment-docs.sh runs in the build box, which has python3 but
# not PyYAML. Console builds that reached 03-docs stopped there on
# `import yaml`, with exit 1 and its site live. This runs the hook on a
# scaffolded tree under a python3 with no third-party packages, and checks it
# reads SITE_URL from intent.yaml the same way with and without PyYAML.
# Offline: the probes find nothing, which the record says as "unreachable".
set -euo pipefail
here="$(cd "$(dirname "$0")/.." && pwd)"
work="$(mktemp -d)"; trap 'rm -rf "$work"' EXIT

python3 -m venv --without-pip "$work/bare"
if "$work/bare/bin/python3" -c 'import yaml' 2>/dev/null; then
echo "render.test.sh: the bare python3 still imports yaml — cannot test" >&2; exit 1
fi

site="$work/site"; mkdir -p "$site/.github/workflows"
mkdir -p "$site/.rebrand"
printf '{"reponame":"acme-notes","subdomain":"acme"}\n' > "$site/.rebrand/values.json"
printf '# Acme Notes\n\nA site.\n' > "$site/README.md"
printf 'jobs:\n lane:\n steps:\n - with:\n version: v2.78.4\n' > "$site/.github/workflows/ci.yml"
cat > "$site/intent.yaml" <<'YAML'
execution:
state:
workspace: ws_TEST0000
environments:
stage:
env:
BASE_DOMAIN: acme.dev
prod:
# a custom domain
env:
SITE_URL: "https://acme.dev/" # trailing slash dropped
YAML

fail=0
for py in "$work/bare/bin" ""; do
label="${py:+without PyYAML}"; label="${label:-with the system python3}"
[ -n "$py" ] || python3 -c 'import yaml' 2>/dev/null || { echo " (skipped: system python3 has no PyYAML)"; continue; }
rm -f "$site/ai/context/deployment.md"
if ! (cd "$site" && PATH="${py:+$py:}$PATH" bash "$here/hooks/render-deployment-docs.sh" . ws_TEST0000 "$here" >/dev/null 2>"$work/err"); then
echo " ✕ $label: the hook failed"; sed 's/^/ /' "$work/err"; fail=1; continue
fi
rec="$site/ai/context/deployment.md"
grep -q 'stage `https://acme-notes-web-stage.acme.workers.dev`' "$rec" || { echo " ✕ $label: stage origin is not the workers.dev URL"; fail=1; }
grep -q 'prod `https://acme.dev`' "$rec" || { echo " ✕ $label: prod origin is not SITE_URL"; fail=1; }
grep -q '<!-- 03-docs:begin -->' "$site/README.md" || { echo " ✕ $label: README section missing"; fail=1; }
[ "$fail" = 0 ] && echo " $label: record rendered, SITE_URL read"
done
[ "$fail" = 0 ] || exit 1
echo "render.test.sh: ok"
Loading