Skip to content

Commit e1f52b4

Browse files
Vivswansettings-as-code-release
andauthored
docs: name the fleet sync and the central CI in plain words instead of the platform repository (#135)
Co-authored-by: settings-as-code-release <settings-as-code-release@users.noreply.github.com>
1 parent b0ff111 commit e1f52b4

15 files changed

Lines changed: 32 additions & 31 deletions

‎.github/actionlint.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Repo-owned actionlint configuration. Generated once by
2-
# Vivswan/repo-platform and never overwritten by template
2+
# the fleet sync and never overwritten by a later
33
# sync, so add this repository's own ignores freely.
44

55
paths:

‎.github/scripts/coverage-data.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ outOfScope:
232232
- >-
233233
Repo-content-borne configuration (CODEOWNERS, dependabot.yml, workflow files, issue/PR
234234
templates, FUNDING.yml, .gitattributes): These are versioned files in the repository tree,
235-
managed by commits/PRs (e.g. by the repo-platform sync), not by the settings REST API.
235+
managed by commits/PRs (e.g. by the fleet sync), not by the settings REST API.
236236
Writing repo content is a different tool's job.
237237
- >-
238238
Self-hosted runners (repo-level registration, labels): Operational infrastructure lifecycle:

‎.github/settings.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
# This repository's OWN settings. Two writers are built to apply the SAME six-layer
3-
# merge of this file with the fleet layers: Vivswan/repo-platform's central
3+
# merge of this file with the fleet layers: the fleet's central
44
# settings-repos heal, and this repo's own apply-settings.yml, the hook for
5-
# ci.yml's post-green slot: it renders the merge with repo-platform's
5+
# ci.yml's post-green slot: it renders the merge with the fleet's
66
# scripts and applies it with the action at HEAD (dogfooding,
77
# APPLY_SETTING_TOKEN).
88
# Rendered once, repo-owned: template sync never rewrites it. Fleet defaults

‎.github/workflows/apply-settings.yml‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# The most direct consumer of this action is this repository itself: its
22
# settings are applied by the CURRENT code (uses: ./), so a regression here
33
# bites us before it bites anyone else. The document it applies is the
4-
# SAME six-layer merge Vivswan/repo-platform computes for this repository
4+
# SAME six-layer merge the fleet's central settings run computes for this
5+
# repository
56
# (the settings-sync module: fleet baseline, module layers, this repo's
6-
# .github/settings.yml, the fleet override), rendered with repo-platform's
7+
# .github/settings.yml, the fleet override), rendered with the platform's
78
# own scripts, so this writer and the central heal converge on one
8-
# document: each renders from a green repo-platform commit, so two runs
9+
# document: each renders from a green platform commit, so two runs
910
# can differ only by a platform revision, and the next heal settles it.
1011
# Applying this repo's partial settings.yml alone would delete every fleet
1112
# label the merged roster carries. Needs APPLY_SETTING_TOKEN
@@ -14,7 +15,7 @@
1415
# Called from post-green.yml, the repo-owned hook ci.yml runs after the
1516
# all-green gate and before release (the judged commit as `sha`, secrets:
1617
# inherit): that call is the only write trigger, so settings never come from
17-
# a commit the gate has not passed. The weekly heal is repo-platform's
18+
# a commit the gate has not passed. The weekly heal is the fleet's
1819
# central settings run; a dispatch only reports drift.
1920

2021
name: Apply Settings
@@ -56,7 +57,7 @@ jobs:
5657
echo "proceed=true" >> "$GITHUB_OUTPUT"
5758
else
5859
echo "::notice::APPLY_SETTING_TOKEN is not set; self-apply skipped. Add a fine-grained PAT secret" \
59-
"(Administration + Issues, read and write) to enable it. Vivswan/repo-platform's central" \
60+
"(Administration + Issues, read and write) to enable it. The fleet's central" \
6061
"settings run applies this repository's settings either way."
6162
echo "proceed=false" >> "$GITHUB_OUTPUT"
6263
fi
@@ -72,14 +73,14 @@ jobs:
7273
with:
7374
ref: ${{ github.event_name == 'workflow_dispatch' && github.event.repository.default_branch || inputs.sha }}
7475

75-
# repo-platform's `build` branch is the green-gated delivery ref the
76+
# The platform's `build` branch is the green-gated delivery ref the
7677
# fleet pins, but its tree carries only workflow files, never the
7778
# scripts. Its tip commit message carries a provenance stamp naming
7879
# the green main commit it was composed from (the same
7980
# `source: .../commit/<sha>` line reusable-apply-settings.yml
8081
# parses), so the scripts are checked out THERE: the exact commit
8182
# CI vouched for. A tip without a stamp fails closed.
82-
- name: Resolve the repo-platform scripts commit
83+
- name: Resolve the platform scripts commit
8384
id: scripts
8485
if: steps.token.outputs.proceed == 'true'
8586
env:
@@ -88,12 +89,12 @@ jobs:
8889
message="$(gh api repos/Vivswan/repo-platform/commits/build --jq '.commit.message')"
8990
stamp="$(printf '%s\n' "$message" | sed -n -E 's|^source: .*/commit/([0-9a-f]{40})$|\1|p' | head -n 1)"
9091
if [ -z "$stamp" ]; then
91-
echo "::error::refusing to run repo-platform scripts: the build tip carries no provenance stamp."
92+
echo "::error::refusing to run the platform scripts: the build tip carries no provenance stamp."
9293
exit 1
9394
fi
9495
echo "ref=$stamp" >> "$GITHUB_OUTPUT"
9596
96-
- name: Check out repo-platform
97+
- name: Check out the platform scripts
9798
if: steps.token.outputs.proceed == 'true'
9899
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
99100
with:
@@ -108,7 +109,7 @@ jobs:
108109
with:
109110
bun-version-file: platform/.bun-version
110111

111-
- name: Install repo-platform script dependencies
112+
- name: Install the platform script dependencies
112113
if: steps.token.outputs.proceed == 'true'
113114
working-directory: platform
114115
run: bun install --frozen-lockfile --silent

‎.github/workflows/auto-format.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Repo-owned auto-format: label a pull request `fix-lint` (the label ships
22
# with the template's settings.yml) and this workflow pushes a formatting
33
# commit to the PR branch, then removes the label. Generated once by
4-
# Vivswan/repo-platform and never overwritten by template
4+
# the fleet sync and never overwritten by a later
55
# sync: adjust the format commands to this repository's tooling.
66

77
name: Auto Format

‎.github/workflows/copilot-setup-steps.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# job below (it MUST be named copilot-setup-steps) to prepare its
33
# development environment before working on this repository. Triggered on
44
# edits to itself so changes are validated in CI. Generated once by
5-
# Vivswan/repo-platform and never overwritten by template
5+
# the fleet sync and never overwritten by a later
66
# sync: add whatever setup the agent needs (dependencies, generated files,
77
# environment checks).
88

‎.github/workflows/nightly-fuzz.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
# oracle, and runs the freshly built bundle against the mock. Failing iterations
44
# dump artifact directories with contract-shaped report.md files (title +
55
# replay block), which the fuzz-issue steps below turn into one deduplicated
6-
# tracking issue. Repo-owned: generated once by Vivswan/repo-platform and
7-
# never overwritten by template sync.
6+
# tracking issue. Repo-owned: generated once by the fleet sync and
7+
# never overwritten by a later sync.
88
name: Nightly Fuzz
99

1010
on:

‎.github/workflows/nightly.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# Nightly upstream-freshness probes. Generated from the repo-platform nightly
2-
# starter and never overwritten by template sync. The checks job re-cuts the
1+
# Nightly upstream-freshness probes. Generated from the fleet sync's nightly
2+
# starter and never overwritten by a later sync. The checks job re-cuts the
33
# trimmed OpenAPI spec from upstream HEAD (a path-level staleness check) and
44
# typechecks against the latest @octokit/types, so pinned-dependency staleness
55
# fails a night instead of surprising the next manual bump; the float-canary
66
# job re-resolves the lockfile from scratch the way the Dependabot lockfile
77
# workflow does, so a breaking upstream release fails a night instead of
88
# reddening every open Dependabot PR; the report job below files or updates
99
# one label-deduplicated tracking issue on a red night and closes it on a
10-
# green one (see repo-platform's docs/nightly.md).
10+
# green one (see the platform repository's docs/nightly.md).
1111
name: Nightly
1212

1313
on:

‎.github/workflows/post-green.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Repo-owned: generated once by Vivswan/repo-platform, never overwritten by
2-
# sync. ci.yml calls it after the all-green gate, before the release, with
1+
# Repo-owned: generated once by the fleet sync, never overwritten by a
2+
# later sync. ci.yml calls it after the all-green gate, before the release, with
33
# the judged sha. Pending runs coalesce (ci.yml's concurrency group), so
44
# jobs here reconcile current state and stay idempotent.
55

‎.gitleaks.toml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Repo-owned gitleaks config, read by the CI gitleaks job (and local
2-
# `gitleaks git` runs). Seeded once by repo-platform's template and never
3-
# overwritten by sync, so allowlists added here survive updates.
2+
# `gitleaks git` runs). Seeded once by the fleet sync's template and never
3+
# overwritten by a later sync, so allowlists added here survive updates.
44
# [extend] pulls in gitleaks' default ruleset - without it, this file
55
# would REPLACE the defaults and disable every stock rule.
66
# minVersion is honored only by binaries new enough to know it (an older

0 commit comments

Comments
 (0)