You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: add scheduled scanning documentation to README (#22)
The Temporal schedule feature was merged in #4 but the README had no
documentation for it. Adds:
- `SCHEDULE_*` env vars to the configuration table
- Usage examples for enabling and customizing the cron schedule
- Verification commands (`temporal schedule list/describe`)
- Note about the create-or-update pattern for safe restarts
Co-authored-by: Amp <amp@ampcode.com>
Version Guard can automatically run scans on a cron schedule using the Temporal Schedule API. Disabled by default — enable with `SCHEDULE_ENABLED=true`:
274
+
275
+
```bash
276
+
# Enable daily scans at 06:00 UTC (default)
277
+
export SCHEDULE_ENABLED=true
278
+
279
+
# Or customize the schedule
280
+
export SCHEDULE_ENABLED=true
281
+
export SCHEDULE_CRON="*/30 * * * *"# Every 30 minutes
282
+
export SCHEDULE_JITTER="2m"
283
+
```
284
+
285
+
The schedule uses a create-or-update pattern — safe to restart the server without creating duplicate schedules. If the cron expression changes, the existing schedule is updated automatically.
286
+
287
+
```bash
288
+
# Verify the schedule
289
+
temporal schedule list --namespace version-guard-dev
Version Guard extracts metadata (service name, environment, brand) from AWS resource tags. By default, it looks for tags like `app`, `application`, or `service`. You can customize these to match your organization's tagging conventions:
0 commit comments