From d13a3b6a61256b2c19141492809dab4559809bde Mon Sep 17 00:00:00 2001 From: Vector Date: Wed, 29 Jul 2026 11:51:18 -0500 Subject: [PATCH] docs: correct misleading DO NOT EDIT header on seeded files seeded_files are written once at repo creation and owned by the repository afterwards (lifecycle ignore_changes = [content]), so 'DO NOT EDIT!' is the opposite of the truth for .cspell.config.yaml. Comments only. No behaviour change, no files moved between locals. Reaches newly created repositories only - existing repos keep their seeded copy by design. Co-Authored-By: Claude Opus 5 --- src/main.tf | 4 ++++ src/templates/all/.cspell.config.yaml | 8 +++++--- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/src/main.tf b/src/main.tf index 0212e1e..1de06dd 100644 --- a/src/main.tf +++ b/src/main.tf @@ -24,6 +24,10 @@ locals { } } + # Managed files. Terraform overwrites these on every run, so repositories + # cannot diverge from the template - changes must be made upstream here. + # Contrast with seeded_files below; the only thing separating the two + # categories is which local a file is placed in. files = { ".github/workflows/sanity_checks.yml" = { content = file("templates/all/.github/workflows/sanity_checks.yml") diff --git a/src/templates/all/.cspell.config.yaml b/src/templates/all/.cspell.config.yaml index ccb7347..a07e10e 100644 --- a/src/templates/all/.cspell.config.yaml +++ b/src/templates/all/.cspell.config.yaml @@ -1,7 +1,9 @@ --- -## DO NOT EDIT! -# This file was provisioned by Terraform -# File origin: https://github.com/Arrow-air/tf-github/tree/main/src/templates/all/.cspell.config.yaml +## SEEDED FILE - this repository owns it. +# Terraform wrote this file once, when the repository was created, and will not +# update it again. Local changes are preserved. Edit it freely. +# Upstream default: https://github.com/Arrow-air/tf-github/tree/main/src/templates/all/.cspell.config.yaml +# Changing the upstream default affects newly created repositories only. $schema: https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json version: "0.2"