Skip to content

Commit 6e2e1a5

Browse files
committed
chore(governance): stop declaring repository identity in settings.yml
probot/settings applies this file on every push to the default branch, so `name`, `description`, `homepage` and `private` here are instructions, not documentation. The estate has already paid for that: the template carried `name: "{{REPO}}"`, GitHub collapsed the illegal braces to dashes, the repo renamed itself to `-REPO-` on every push and its old URL 404'd. This file now matches the template's own header and rule, with the four identity keys removed and everything else left as it was. Repository identity and visibility are set out of band, once, by the owner. Enforced by scripts/check-no-placeholders.sh.
1 parent 3a9bdff commit 6e2e1a5

1 file changed

Lines changed: 35 additions & 5 deletions

File tree

.github/settings.yml

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,45 @@
77
# applied by the probot/settings app when changes are pushed to the default
88
# branch. Install the app at: https://github.com/apps/settings
99
#
10-
# Template file — replace rattlescript and Python-syntax AffineScript — write Python-style code, get affine resource guarantees and typed WASM with actual values.
10+
# ─── THIS FILE MUST NEVER DECLARE REPOSITORY IDENTITY ─────────────────────────
11+
#
12+
# It carries NO `name`, `description`, `homepage` or `private` key, and it must
13+
# never gain one. The reason is a real incident, not a hypothetical:
14+
#
15+
# This file previously read `name: "{{REPO}}"`. probot/settings applies it on
16+
# every push to the default branch, so it submitted the literal string
17+
# `{{REPO}}` as the repository name. GitHub sanitises an invalid name by
18+
# collapsing each run of illegal characters to a dash — `{{REPO}}` became
19+
# `-REPO-`. The template renamed itself on every push, its old URL 404'd, and
20+
# it was mistaken for a deleted repository. `description` was likewise left
21+
# reading the literal `{{DESCRIPTION}}` on the live repo.
22+
#
23+
# Two properties make identity keys unsafe here specifically:
24+
#
25+
# 1. This is a TEMPLATE. `just repo-init` fills placeholders in repos minted by the
26+
# scaffolder — but GitHub's "Use this template" button copies the default
27+
# branch verbatim and never runs `just repo-init`. Any placeholder left in a
28+
# probot-managed file therefore reaches children unrendered.
29+
# 2. Identity is not shareable. The template must be public while children
30+
# default private; a child cannot inherit either `name` or `private` from
31+
# its parent without being wrong.
32+
#
33+
# Repository identity and visibility are therefore set OUT OF BAND: once per
34+
# repo, at creation time, by the operator (the Configure stage of ADR-0003).
35+
# `just repo-init` deliberately runs NO `gh` commands — it prints the exact
36+
# `gh repo edit` commands as next steps instead. Fail-closed default: repos
37+
# stay private unless the owner flips visibility deliberately; the template's
38+
# own name and visibility are set deliberately by the owner.
39+
#
40+
# Everything below is safe to inherit: it is true of every RSR repo regardless
41+
# of that repo's name, purpose or visibility.
42+
#
43+
# Enforced by `scripts/check-no-placeholders.sh`, which fails if this file
44+
# contains a `{{` token or declares any of the four identity keys.
1145

1246
# ─── Repository Settings ───────────────────────────────────────────────────────
1347

1448
repository:
15-
name: "rattlescript"
16-
description: "Python-syntax AffineScript — write Python-style code, get affine resource guarantees and typed WASM"
17-
homepage: "https://github.com/hyperpolymath/rattlescript"
18-
private: false
1949
has_issues: true
2050
has_projects: true
2151
has_wiki: false

0 commit comments

Comments
 (0)