Move documents to docs/ and the example config to configs/ (closes #411)
check / check (push) Successful in 16m18s

ARCHITECTURE.md and TODO.md move to docs/, config.example.yml to
configs/, as REPO_POLICIES.md asks of the root. Links, the
no-snapshots error message and the example-config test follow them.

Model: opus-5-5
This commit is contained in:
sneak committed 2026-11-10 21:38:48 +00:00
1 parent 38b588f658
commit fdeec22de7
7 files changed
+18 -13

No files matched your search

+1 -1
View File
@@ -56,7 +56,7 @@ var (
errRecipientNotX25519 = errors.New(
"not a valid recipient; only X25519 age1... public keys are supported")
errNoSnapshots = errors.New(
"at least one snapshot must be configured (see config.example.yml)")
"at least one snapshot must be configured (see configs/config.example.yml)")
errSnapshotNoPaths = errors.New("snapshot must have at least one path")
errChunkSizeTooSmall = errors.New("chunk_size must be at least 1MB")
errBlobSizeTooSmall = errors.New(
+4 -4
View File
@@ -90,12 +90,12 @@ func TestConfigLoad(t *testing.T) {
}
// TestExampleConfigIsScrubbedAndLoads checks that the shipped
// config.example.yml carries only neutral placeholders (no real credentials,
// private addresses, or internal host names) and still parses.
// configs/config.example.yml carries only neutral placeholders (no real
// credentials, private addresses, or internal host names) and still parses.
func TestExampleConfigIsScrubbedAndLoads(t *testing.T) {
t.Parallel()
examplePath := filepath.Join("..", "..", "config.example.yml")
examplePath := filepath.Join("..", "..", "configs", "config.example.yml")
cfg, err := Load(examplePath)
if err != nil {
@@ -361,7 +361,7 @@ func TestDocumentedSizeDefaults(t *testing.T) {
}
// TestDocumentedSizeExamples checks the 1MB minimum chunk_size and that
// every size the README, config.example.yml and the config init template
// every size the README, configs/config.example.yml and the config init template
// list as an example is accepted.
func TestDocumentedSizeExamples(t *testing.T) {
t.Parallel()