Skip to content

docs(scouts): scrub host-TZ/DST reference from README#52

Merged
theagenticguy merged 1 commit intomainfrom
docs/scrub-tz-leak
Apr 22, 2026
Merged

docs(scouts): scrub host-TZ/DST reference from README#52
theagenticguy merged 1 commit intomainfrom
docs/scrub-tz-leak

Conversation

@theagenticguy
Copy link
Copy Markdown
Owner

Summary

The README's cron section leaked internal ops context ("if your devbox runs UTC and you want local-CST time, convert accordingly… DST will shift the run by an hour twice a year") — that's our own setup talking to itself, not scheduler-agnostic user docs.

Change

Replace with a scheduler-neutral section that lists cron, systemd timers, GitHub Actions schedule:, and launchd as equally valid options, and keeps only the genuinely useful guidance (pin RALPH_USER_DIR in the entry; seed a scout before the first run).

Test plan

Docs-only; no code paths touched.

The 'crontab times are in the host's local timezone' paragraph leaked
the ops context of our own devbox (UTC host, CDT user). Replace with a
scheduler-agnostic note that lists cron, systemd timers, GitHub Actions,
and launchd — the scout CLI doesn't care which one you use, and
customers shouldn't read internal ops details in what is otherwise a
clean target-architecture doc.
Copilot AI review requested due to automatic review settings April 22, 2026 12:07
@github-actions
Copy link
Copy Markdown
Contributor

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the scouts/ README to remove internal host timezone/DST guidance and replace it with a scheduler-neutral “run on a schedule” section that applies across environments.

Changes:

  • Renames the cron-specific section to a scheduler-agnostic “Running on a schedule”.
  • Broadens scheduling options mentioned (cron/systemd/GitHub Actions/launchd).
  • Updates the example and guidance around setting RALPH_USER_DIR and seeding a scout before scheduled runs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread scouts/README.md
Comment on lines +63 to +65
Scouts are a CLI, so any scheduler works — cron, systemd timers, GitHub
Actions `schedule:`, launchd on macOS. Pin `RALPH_USER_DIR` in the entry if
you want scout data to live outside the repo:
Copy link

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The list of “any scheduler works — … GitHub Actions schedule: …” is a bit misleading given this README’s earlier guidance that scouts/ is user data and not committed. A GitHub Actions runner is typically ephemeral and won’t retain scouts/ between runs, so scheduled runs won’t work unless you also document how to provision/seed scouts on every run (or where they come from). Consider either removing GitHub Actions from the “equally valid” list or adding a short qualifier about needing to create/provide scouts on the runner each run.

Copilot uses AI. Check for mistakes.
Comment thread scouts/README.md
Comment on lines +68 to +69
RALPH_USER_DIR=$HOME/ralph-data
0 9 * * * /path/to/ralph-for-kiro scout \
Copy link

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The text says “Pin RALPH_USER_DIR in the entry”, but the example sets RALPH_USER_DIR on its own line. That standalone assignment only applies if it’s placed as an environment setting line in the crontab (not inside a script), so readers may paste this into the wrong place. Consider either putting RALPH_USER_DIR=... inline on the 0 9 * * * ... line, or explicitly label it as a crontab-wide env var line.

Suggested change
RALPH_USER_DIR=$HOME/ralph-data
0 9 * * * /path/to/ralph-for-kiro scout \
0 9 * * * RALPH_USER_DIR=$HOME/ralph-data /path/to/ralph-for-kiro scout \

Copilot uses AI. Check for mistakes.
Comment thread scouts/README.md
Comment on lines +74 to +75
The scheduler will fail silently if `scouts/` is empty — seed with
`ralph scout init` or `--from-example` once before the first run.
Copy link

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

“The scheduler will fail silently if scouts/ is empty” isn’t quite accurate: ralph scout logs an error (“No scouts found…”) and returns, and it’s the scheduled run (not the scheduler) that does nothing. Consider rewording to something like “Scheduled runs will exit without doing work if no scouts exist; run ralph scout init … first”, and (if relevant) note that redirecting output is how you avoid missing the error in cron.

Suggested change
The scheduler will fail silently if `scouts/` is empty — seed with
`ralph scout init` or `--from-example` once before the first run.
Scheduled runs will exit without doing work if no scouts exist — run
`ralph scout init <name>` or `ralph scout init --from-example <template> <name>`
once before the first scheduled run.

Copilot uses AI. Check for mistakes.
@theagenticguy theagenticguy merged commit e324f41 into main Apr 22, 2026
11 checks passed
@theagenticguy theagenticguy deleted the docs/scrub-tz-leak branch April 22, 2026 12:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants