docs(config): document chat.telegram.token_env in config.example.toml
TelegramConfig.TokenEnv was a real, used field with no example-file mention -- an operator reading the template wouldn't discover the key exists.
This commit is contained in:
1 parent
3c48889309
commit
254c0cc4c0
2 files changed
+2
-1
No files matched your search
+1
-1
@@ -260,7 +260,7 @@
|
||||
{"_type":"issue","id":"archie-core-1786637499063-352-c2b85c1a","title":"fix(gateway): synchronize sessionTracker.active","description":"sessionTracker.active is a plain map with no mutex. go-telegram/bot dispatches each update in its own goroutine, so resolve() writes it while getActive() reads it concurrently. Backend-agnostic Go data race.","status":"closed","priority":2,"issue_type":"task","created_at":"2026-08-08T14:54:29Z","updated_at":"2026-08-08T15:34:03Z","closed_at":"2026-08-08T15:34:04Z","external_ref":"https://github.com/samcharles93/archie-core/issues/373","source_system":"github:https://github.com/samcharles93/archie-core/issues/373:373","metadata":null,"labels":["task"],"dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"_type":"issue","id":"archie-core-1786637499041-351-b4253aa3","title":"Link pushed task branch to source issue before opening PR","description":"After the task branch is successfully pushed, call the forge branch-link operation for the source issue, then create the PR without relying on a PR comment or Closes directive to associate it. Propagate link failures and cover Gitea plus forge RPC behavior.","status":"closed","priority":2,"issue_type":"bug","created_at":"2026-08-08T14:54:23Z","updated_at":"2026-08-08T14:54:26Z","closed_at":"2026-08-08T14:54:27Z","external_ref":"https://github.com/samcharles93/archie-core/issues/372","source_system":"github:https://github.com/samcharles93/archie-core/issues/372:372","metadata":null,"labels":["bug"],"dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"_type":"issue","id":"archie-core-1786637499018-350-0fc03bf9","title":"Per-repo allow_concurrent override for same-repo multi-agent work","description":"Concurrent agents on the same repo are blocked by default (worktree conflict). PRD sec.9 open question 5 proposes a per-repo config override (allow_concurrent = true) for repos where parallel work is safe (different base branches, different packages). Deferred to Phase 2 in the PRD; depends on the daemon supporting concurrent task dispatch at all.\n\n### Acceptance Criteria\n\nRepos with allow_concurrent = true in [[repos]] config can have multiple agents working simultaneously without worktree collisions; repos without it keep current serialized behavior.","status":"closed","priority":2,"issue_type":"feature","created_at":"2026-08-08T14:54:18Z","updated_at":"2026-08-08T14:54:21Z","closed_at":"2026-08-08T14:54:22Z","external_ref":"https://github.com/samcharles93/archie-core/issues/371","source_system":"github:https://github.com/samcharles93/archie-core/issues/371:371","metadata":null,"labels":["enhancement"],"dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"_type":"issue","id":"archie-core-1786637498998-349-fe936acb","title":"config.example.toml has no token_env placeholder under [chat.telegram]","description":"TelegramConfig.TokenEnv (internal/config/config.go:536) is a real, used field (cmd/archied/telegram_setup.go reads it via os.Getenv), but the commented [chat.telegram] block in config.example.toml only documents update_check_command / update_install_command -- there is no \"# token_env = ...\" line. An operator reading the example file to learn what's configurable would not discover this key exists.\n\nDiscovered while implementing archie-core-rs9 and testing tomlwrite.Apply against the real template: setting chat.telegram.token_env for the first time falls through to Apply's \"key not found in table\" path (uncomment header, append key), which works fine -- this is a documentation completeness gap in the template, not a functional blocker for archie-core-cbk.\n\n### Acceptance Criteria\n\nAdd a commented `# token_env = \"...\"` line (with a short comment on what it should point to, e.g. an env var containing the @BotFather token) under the commented [chat.telegram] block in config.example.toml, matching the style of the other commented-out optional fields.","status":"open","priority":2,"issue_type":"task","created_at":"2026-08-08T14:54:15Z","updated_at":"2026-08-08T14:54:15Z","external_ref":"https://github.com/samcharles93/archie-core/issues/370","source_system":"github:https://github.com/samcharles93/archie-core/issues/370:370","metadata":null,"labels":["task"],"dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"_type":"issue","id":"archie-core-1786637498998-349-fe936acb","title":"config.example.toml has no token_env placeholder under [chat.telegram]","description":"TelegramConfig.TokenEnv (internal/config/config.go:536) is a real, used field (cmd/archied/telegram_setup.go reads it via os.Getenv), but the commented [chat.telegram] block in config.example.toml only documents update_check_command / update_install_command -- there is no \"# token_env = ...\" line. An operator reading the example file to learn what's configurable would not discover this key exists.\n\nDiscovered while implementing archie-core-rs9 and testing tomlwrite.Apply against the real template: setting chat.telegram.token_env for the first time falls through to Apply's \"key not found in table\" path (uncomment header, append key), which works fine -- this is a documentation completeness gap in the template, not a functional blocker for archie-core-cbk.\n\n### Acceptance Criteria\n\nAdd a commented `# token_env = \"...\"` line (with a short comment on what it should point to, e.g. an env var containing the @BotFather token) under the commented [chat.telegram] block in config.example.toml, matching the style of the other commented-out optional fields.","status":"closed","priority":2,"issue_type":"task","assignee":"Sam Catlow","created_at":"2026-08-08T14:54:15Z","updated_at":"2026-09-02T10:44:38Z","started_at":"2026-09-02T10:44:08Z","closed_at":"2026-09-02T10:44:38Z","close_reason":"Added a commented token_env placeholder under [chat.telegram] in config.example.toml, matching the style of the other optional fields.","external_ref":"https://github.com/samcharles93/archie-core/issues/370","source_system":"github:https://github.com/samcharles93/archie-core/issues/370:370","metadata":null,"labels":["task"],"dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"_type":"issue","id":"archie-core-1786637498978-348-c221a031","title":"Export configuration.Validate for archied setup to call","description":"The ewk epic's acceptance criteria (and archie-core-cbk's, by inheritance) require: \"Every config it writes passes configuration.Validate, verified by a test that runs setup non-interactively and validates the output.\" That identifier does not exist. internal/infrastructure/configuration/validate.go defines only an unexported validate(cfg *config.Config) error, called from one place: loader.go:178 inside Loader.Load's own decode-then-validate sequence. There is no way for code outside the configuration package -- e.g. `archied setup` after it builds a config.Config in memory but before writing it to disk -- to run the same validation.\n\nDiscovered while implementing archie-core-rs9 (TOML write strategy). Not fixed there: rs9's scope was the text-patching mechanism, not wiring setup's actual validation step, and exporting validate() is really part of cbk's job (the thing that needs to call it).\n\n### Acceptance Criteria\n\nconfiguration package exposes a callable that runs the same checks as the current unexported validate() against a config.Config value in memory (either export validate itself, or add a thin Validate(cfg *config.Config) error wrapper -- whichever fits the package's existing exported-surface conventions). Loader.Load continues to use it internally with no behavior change. A test outside the package (e.g. in cbk's setup tests) can call it directly without going through file I/O.","status":"closed","priority":2,"issue_type":"task","created_at":"2026-08-08T14:54:10Z","updated_at":"2026-08-08T14:54:13Z","closed_at":"2026-08-08T14:54:14Z","external_ref":"https://github.com/samcharles93/archie-core/issues/369","source_system":"github:https://github.com/samcharles93/archie-core/issues/369:369","metadata":null,"labels":["task"],"dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"_type":"issue","id":"archie-core-1786637498957-347-60ea9b86","title":"[EPIC] archied setup: interactive first-run configuration","description":"Move config generation out of install.sh and into the daemon as 'archied setup', so the thing that writes config.toml is the same code that reads it. install.sh currently hand-rolls TOML and has already drifted from the schema once: it hardcoded the GitHub token key and the Gitea host, so a Gitea install produced a config naming a token the installer never wrote. Modelled on tau's 'tau setup' (internal/cli/setup.go, internal/app/setup.go), adapted for archie's TOML config and existing secret-reference indirection.\n\n### Design\n\nPort from tau: the CLI/app split behind a SetupPrompter interface so business logic is UI-agnostic and testable without a terminal; plain-stdio Select and hidden ReadSecret (golang.org/x/term) racing ctx.Done for Ctrl+C -- no TUI dependency; atomic temp+rename writes. DIVERGENCE FROM TAU: tau surgically patches YAML nodes to preserve comments. archie uses BurntSushi/toml, which does not preserve comments across a decode/encode round trip, so a full re-marshal would destroy config.example.toml's documentation. Decide this explicitly -- see the child issue. Secrets differ too: archie already has secret.SecretRef{engine,key} indirection, so setup writes the reference into TOML and the value into the env engine's store; that is archie's equivalent of tau's config.yaml/auth.yaml split and should be used rather than reinvented.\n\n### Acceptance Criteria\n\ninstall.sh no longer generates config.toml; it invokes archied setup. Setup is idempotent and re-runnable against an existing config without clobbering unrelated settings. Every config it writes passes configuration.Validate, verified by a test that runs setup non-interactively and validates the output. Secrets never reach config.toml or argv: config holds a secret reference, the value goes to the env file at 0600 via atomic write. Prompts for secrets do not echo. A non-TTY invocation without sufficient input fails with a clear message rather than writing a partial config.","status":"open","priority":2,"issue_type":"epic","created_at":"2026-08-08T14:54:07Z","updated_at":"2026-08-08T14:54:07Z","external_ref":"https://github.com/samcharles93/archie-core/issues/368","source_system":"github:https://github.com/samcharles93/archie-core/issues/368:368","metadata":null,"labels":["epic"],"dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"_type":"issue","id":"archie-core-1786637498934-346-eeaf0e27","title":"telegram: publish /new /retry /undo in menu and help","description":"TestPublishedCommandsMatchExecutableCommandSurface in\ninternal/channels/telegram/telegram_test.go fails: /new, /retry and /undo are\nexecutable commands but are missing from the published command menu and the\nhelp text, so users cannot discover them.\n\nRun: go test ./internal/channels/telegram/...\n\nScope:\n- ONLY internal/channels/telegram/. Do not touch any other package.\n- Read the test to see how it derives the executable command surface, then add\n the three commands to whichever menu/help structures it compares against.\n- Match the existing entries' wording style and ordering conventions.\n\nConstraints:\n- Do NOT add //nolint or otherwise suppress lint findings.\n- Do NOT modify the test to make it pass. The test is correct: these commands\n really are missing from the menu.\n- Do NOT write architecture docs, ledgers, plans or new beads.\n\nDone when: go build ./... , go vet ./... , gofmt -l . clean, and\ngo test ./internal/channels/telegram/... passes.","status":"closed","priority":2,"issue_type":"task","created_at":"2026-08-08T14:54:02Z","updated_at":"2026-08-08T14:54:04Z","closed_at":"2026-08-08T14:54:05Z","external_ref":"https://github.com/samcharles93/archie-core/issues/367","source_system":"github:https://github.com/samcharles93/archie-core/issues/367:367","metadata":null,"labels":["task"],"dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
|
||||
@@ -135,6 +135,7 @@ class = "ollama"
|
||||
# shell snippets). The check command must write a releaseupdate.Snapshot JSON
|
||||
# document to stdout; configure the installer as well to show Approve/Defer.
|
||||
# [chat.telegram]
|
||||
# token_env = "TELEGRAM_BOT_TOKEN" # env var holding the bot token from @BotFather
|
||||
# update_check_command = ["/usr/local/bin/archie-update-check"]
|
||||
# update_install_command = ["/usr/local/bin/archie-update-install"]
|
||||
|
||||
|
||||
Reference in new issue
Block a user