pr-shepherd 0.47.0 → 0.48.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/plugin.json +1 -1
- package/README.md +2 -0
- package/bin/api.d.mts +1 -1
- package/bin/cli/args.mjs +1 -0
- package/bin/cli/default-poll.mjs +1 -0
- package/bin/cli/help-command-pages.d.mts +1 -1
- package/bin/cli/help-iterate-poll-pages.d.mts +1 -1
- package/bin/cli/help-iterate-poll-pages.mjs +6 -5
- package/bin/cli/help-top-page.d.mts +1 -1
- package/bin/cli/help-top-page.mjs +5 -4
- package/bin/cli/help.d.mts +2 -2
- package/bin/cli/poll-handler.mjs +15 -7
- package/bin/commands/iterate/api-usage.d.mts +1 -1
- package/bin/commands/iterate/api-usage.mjs +6 -2
- package/bin/commands/iterate/run.mjs +1 -1
- package/bin/commands/poll-run.d.mts +1 -1
- package/bin/commands/poll-run.mjs +2 -2
- package/bin/commands/poll.mjs +2 -1
- package/bin/config/load.d.mts +7 -0
- package/bin/config/load.mjs +70 -19
- package/bin/config.json +9 -3
- package/bin/quota-warning.mjs +1 -1
- package/bin/types/iterate.d.mts +3 -3
- package/package.json +1 -1
- package/plugins/pr-shepherd/.codex-plugin/plugin.json +1 -1
- package/plugins/pr-shepherd/.codex.mcp.json +1 -1
- package/plugins/pr-shepherd/.mcp.json +1 -1
package/README.md
CHANGED
|
@@ -137,6 +137,8 @@ pr-shepherd owner/repo#42 # poll a PR in an explicit repository
|
|
|
137
137
|
pr-shepherd https://github.com/owner/repo/pull/42
|
|
138
138
|
```
|
|
139
139
|
|
|
140
|
+
Polling defaults can be set under `poll` in `.pr-shepherdrc.yml`: `intervalSeconds`, `timeoutSeconds`, `debounceSeconds`, and `quietStatus`. Explicit flags override configuration, including `--no-quiet-status` when a shared config enables quiet output. Quiet status remains off by default.
|
|
141
|
+
|
|
140
142
|
### Apply Review And Journal Changes, Or Select Files
|
|
141
143
|
|
|
142
144
|
Use `apply` with ordered operations to reply/resolve/minimize/dismiss review items, mark selected changed files as viewed, or append an idempotent Shepherd Journal item. Explicit operations are attempted and surface GitHub's per-operation results; generated iterate guidance remains capability-filtered. Use `build_suggestion_patches` to turn ordered review suggestions into checked patches and commit metadata; it never changes the worktree or git history.
|
package/bin/api.d.mts
CHANGED
|
@@ -8,7 +8,7 @@ export interface CreatePrShepherdOptions {
|
|
|
8
8
|
}
|
|
9
9
|
/** A positive PR number, GitHub pull-request URL, or owner/repo#number reference. */
|
|
10
10
|
export type PrReference = number | string;
|
|
11
|
-
export type IterateInput = Omit<IterateCommandOptions, "format" | "prNumber" | "targetRepository" | "persistSeen" | "fingerprintCache" | "deferQuotaWarning"> & {
|
|
11
|
+
export type IterateInput = Omit<IterateCommandOptions, "format" | "prNumber" | "targetRepository" | "persistSeen" | "fingerprintCache" | "deferQuotaWarning" | "quotaWarningMinimumPollIntervalMinutes"> & {
|
|
12
12
|
pr?: PrReference;
|
|
13
13
|
};
|
|
14
14
|
export interface ReviewMutationsOperation {
|
package/bin/cli/args.mjs
CHANGED
package/bin/cli/default-poll.mjs
CHANGED
|
@@ -194,7 +194,7 @@ Flags:
|
|
|
194
194
|
PR may be a number or GitHub pull request URL. When omitted, the current branch PR is inferred.
|
|
195
195
|
Exit code: 0 on success; nonzero on failure (sysexits.h — see docs/exit-codes.md).`;
|
|
196
196
|
readonly iterate: "pr-shepherd iterate\n\nRun one iterate tick for a pull request. The no-subcommand form polls; use this subcommand for a single tick.\nThe output contains one action and an action-specific ## Instructions section.\n\nUsage:\n pr-shepherd iterate [PR] [iterate-flags]\n\nIterate flags:\n --ready-delay <duration> Settle window before a clean PR cancels. Bare number = minutes. Example: 15m.\n --stall-timeout <duration> Escalate repeated unchanged failures after this duration. Bare number = minutes. 0 disables.\n --no-auto-mark-ready Do not convert draft PRs to ready for review.\n --no-auto-cancel-actionable Legacy no-op; workflow runs are never cancelled.\n --merge Shepherd through readiness, then emit a merge or merge-queue command.\n --format text|json Output Markdown text or JSON. Default: text.\n --verbose Include verbose iterate fields.\n --help, -h Print this help and exit before GitHub, git, config, or log I/O.\n\nDurations accept s/m/h suffixes: 30s, 4.5m, 1h. A bare number is minutes; decimals are allowed only with an explicit unit (4.5m).\n\nActions:\n WAIT No immediate action; continue with the next poll.\n MARK_READY Draft PR was marked ready; continue with the next poll.\n FIX_CODE Agent action is required; follow the instructions, then continue polling.\n CANCEL Stop polling: merged/closed or ready-delay elapsed.\n ESCALATE Stop polling until a human provides direction.\n MERGE Run the emitted merge/queue command, then continue monitoring.\n\nExit codes:\n 0 CANCEL (merged or ready-delay elapsed)\n 10 WAIT\n 11 MARK_READY\n 12 FIX_CODE\n 13 ESCALATE\n 14 CANCEL (closed without merging)\n 15 MERGE\n A command/validation/GitHub failure exits with a sysexits.h code instead (see docs/exit-codes.md).";
|
|
197
|
-
readonly poll: "pr-shepherd poll\n\nRun iterate repeatedly for WAIT ticks and during the FIX_CODE debounce window. Print only the\nfinal tick to stdout.\nPoll exits as soon as iterate returns MARK_READY, CANCEL, or ESCALATE, or when timeout\nreturns the last WAIT result. FIX_CODE starts a --debounce settle window (default 1m): poll keeps\niterating at --interval, then runs one more tick after the window and returns that result.\nWith --until-terminal or --merge, poll also continues through MARK_READY.\n\nUsage:\n pr-shepherd poll [PR] [poll-flags] [iterate-flags]\n\nPoll flags:\n --interval <duration> Sleep between WAIT ticks. Bare number = seconds. Default: 60s.\n --timeout <duration> Maximum wall-clock wait for WAIT ticks. Bare number = seconds. Default: 4.5m.\n --debounce <duration> Settle window after first FIX_CODE before returning. Bare number = seconds. Default: 60s. 0 disables.\n --quiet-status
|
|
197
|
+
readonly poll: "pr-shepherd poll\n\nRun iterate repeatedly for WAIT ticks and during the FIX_CODE debounce window. Print only the\nfinal tick to stdout.\nPoll exits as soon as iterate returns MARK_READY, CANCEL, or ESCALATE, or when timeout\nreturns the last WAIT result. FIX_CODE starts a --debounce settle window (default 1m): poll keeps\niterating at --interval, then runs one more tick after the window and returns that result.\nWith --until-terminal or --merge, poll also continues through MARK_READY.\n\nUsage:\n pr-shepherd poll [PR] [poll-flags] [iterate-flags]\n\nPoll flags:\n --interval <duration> Sleep between WAIT ticks. Bare number = seconds. Default: poll.intervalSeconds (built-in 60s).\n --timeout <duration> Maximum wall-clock wait for WAIT ticks. Bare number = seconds. Default: poll.timeoutSeconds (built-in 4.5m).\n --debounce <duration> Settle window after first FIX_CODE before returning. Bare number = seconds. Default: poll.debounceSeconds (built-in 60s). 0 disables.\n --quiet-status Print only changed WAIT snapshots. Overrides poll.quietStatus.\n --no-quiet-status Print every WAIT snapshot. Overrides poll.quietStatus.\n --until-terminal Continue through WAIT/MARK_READY until FIX_CODE/CANCEL/ESCALATE.\n\nForwarded iterate flags:\n --ready-delay <duration> Settle window before a clean PR cancels. Bare number = minutes. Example: 15m.\n --stall-timeout <duration> Escalate repeated unchanged failures after this duration. Bare number = minutes. 0 disables.\n --no-auto-mark-ready Do not convert draft PRs to ready for review.\n --no-auto-cancel-actionable Legacy no-op; workflow runs are never cancelled.\n --merge Shepherd through readiness, then emit a merge or merge-queue command.\n --format text|json Output Markdown text or JSON. Default: text.\n --verbose Include verbose iterate fields and detailed per-tick lines.\n --help, -h Print this help and exit before GitHub, git, config, or log I/O.\n\nDurations accept s/m/h suffixes: 30s, 4.5m, 1h. A bare number uses each flag's default unit (seconds\nfor --interval/--timeout/--debounce, minutes for --ready-delay/--stall-timeout); decimals are allowed only with\nan explicit unit (4.5m).\nEach WAIT tick writes an explicit still-running line to stderr by default; poll.quietStatus can change that default, --quiet-status/--no-quiet-status override it, and --verbose emits detailed per-tick lines.\nFIX_CODE debounce writes a remaining-seconds line to stderr. --timeout does not cut an in-flight debounce short.\nWith --until-terminal, --timeout is ignored for WAIT ticks and polling continues until FIX_CODE, MERGE, CANCEL, or ESCALATE. With --merge, --timeout still bounds WAIT ticks; it only continues through MARK_READY while polling remains within that timeout.\n\nExit codes: same as iterate (the final tick's action/reason decides the code).\n 0 CANCEL (merged or ready-delay elapsed)\n 10 WAIT (including a WAIT returned by --timeout)\n 11 MARK_READY\n 12 FIX_CODE\n 13 ESCALATE\n 14 CANCEL (closed without merging)\n 15 MERGE\n A command/validation/GitHub failure exits with a sysexits.h code instead (see docs/exit-codes.md).";
|
|
198
198
|
readonly clean: `pr-shepherd clean
|
|
199
199
|
|
|
200
200
|
Remove pr-shepherd state files from PR_SHEPHERD_STATE_DIR.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
export declare const ITERATE_USAGE = "pr-shepherd iterate\n\nRun one iterate tick for a pull request. The no-subcommand form polls; use this subcommand for a single tick.\nThe output contains one action and an action-specific ## Instructions section.\n\nUsage:\n pr-shepherd iterate [PR] [iterate-flags]\n\nIterate flags:\n --ready-delay <duration> Settle window before a clean PR cancels. Bare number = minutes. Example: 15m.\n --stall-timeout <duration> Escalate repeated unchanged failures after this duration. Bare number = minutes. 0 disables.\n --no-auto-mark-ready Do not convert draft PRs to ready for review.\n --no-auto-cancel-actionable Legacy no-op; workflow runs are never cancelled.\n --merge Shepherd through readiness, then emit a merge or merge-queue command.\n --format text|json Output Markdown text or JSON. Default: text.\n --verbose Include verbose iterate fields.\n --help, -h Print this help and exit before GitHub, git, config, or log I/O.\n\nDurations accept s/m/h suffixes: 30s, 4.5m, 1h. A bare number is minutes; decimals are allowed only with an explicit unit (4.5m).\n\nActions:\n WAIT No immediate action; continue with the next poll.\n MARK_READY Draft PR was marked ready; continue with the next poll.\n FIX_CODE Agent action is required; follow the instructions, then continue polling.\n CANCEL Stop polling: merged/closed or ready-delay elapsed.\n ESCALATE Stop polling until a human provides direction.\n MERGE Run the emitted merge/queue command, then continue monitoring.\n\nExit codes:\n 0 CANCEL (merged or ready-delay elapsed)\n 10 WAIT\n 11 MARK_READY\n 12 FIX_CODE\n 13 ESCALATE\n 14 CANCEL (closed without merging)\n 15 MERGE\n A command/validation/GitHub failure exits with a sysexits.h code instead (see docs/exit-codes.md).";
|
|
2
|
-
export declare const POLL_USAGE = "pr-shepherd poll\n\nRun iterate repeatedly for WAIT ticks and during the FIX_CODE debounce window. Print only the\nfinal tick to stdout.\nPoll exits as soon as iterate returns MARK_READY, CANCEL, or ESCALATE, or when timeout\nreturns the last WAIT result. FIX_CODE starts a --debounce settle window (default 1m): poll keeps\niterating at --interval, then runs one more tick after the window and returns that result.\nWith --until-terminal or --merge, poll also continues through MARK_READY.\n\nUsage:\n pr-shepherd poll [PR] [poll-flags] [iterate-flags]\n\nPoll flags:\n --interval <duration> Sleep between WAIT ticks. Bare number = seconds. Default: 60s.\n --timeout <duration> Maximum wall-clock wait for WAIT ticks. Bare number = seconds. Default: 4.5m.\n --debounce <duration> Settle window after first FIX_CODE before returning. Bare number = seconds. Default: 60s. 0 disables.\n --quiet-status
|
|
2
|
+
export declare const POLL_USAGE = "pr-shepherd poll\n\nRun iterate repeatedly for WAIT ticks and during the FIX_CODE debounce window. Print only the\nfinal tick to stdout.\nPoll exits as soon as iterate returns MARK_READY, CANCEL, or ESCALATE, or when timeout\nreturns the last WAIT result. FIX_CODE starts a --debounce settle window (default 1m): poll keeps\niterating at --interval, then runs one more tick after the window and returns that result.\nWith --until-terminal or --merge, poll also continues through MARK_READY.\n\nUsage:\n pr-shepherd poll [PR] [poll-flags] [iterate-flags]\n\nPoll flags:\n --interval <duration> Sleep between WAIT ticks. Bare number = seconds. Default: poll.intervalSeconds (built-in 60s).\n --timeout <duration> Maximum wall-clock wait for WAIT ticks. Bare number = seconds. Default: poll.timeoutSeconds (built-in 4.5m).\n --debounce <duration> Settle window after first FIX_CODE before returning. Bare number = seconds. Default: poll.debounceSeconds (built-in 60s). 0 disables.\n --quiet-status Print only changed WAIT snapshots. Overrides poll.quietStatus.\n --no-quiet-status Print every WAIT snapshot. Overrides poll.quietStatus.\n --until-terminal Continue through WAIT/MARK_READY until FIX_CODE/CANCEL/ESCALATE.\n\nForwarded iterate flags:\n --ready-delay <duration> Settle window before a clean PR cancels. Bare number = minutes. Example: 15m.\n --stall-timeout <duration> Escalate repeated unchanged failures after this duration. Bare number = minutes. 0 disables.\n --no-auto-mark-ready Do not convert draft PRs to ready for review.\n --no-auto-cancel-actionable Legacy no-op; workflow runs are never cancelled.\n --merge Shepherd through readiness, then emit a merge or merge-queue command.\n --format text|json Output Markdown text or JSON. Default: text.\n --verbose Include verbose iterate fields and detailed per-tick lines.\n --help, -h Print this help and exit before GitHub, git, config, or log I/O.\n\nDurations accept s/m/h suffixes: 30s, 4.5m, 1h. A bare number uses each flag's default unit (seconds\nfor --interval/--timeout/--debounce, minutes for --ready-delay/--stall-timeout); decimals are allowed only with\nan explicit unit (4.5m).\nEach WAIT tick writes an explicit still-running line to stderr by default; poll.quietStatus can change that default, --quiet-status/--no-quiet-status override it, and --verbose emits detailed per-tick lines.\nFIX_CODE debounce writes a remaining-seconds line to stderr. --timeout does not cut an in-flight debounce short.\nWith --until-terminal, --timeout is ignored for WAIT ticks and polling continues until FIX_CODE, MERGE, CANCEL, or ESCALATE. With --merge, --timeout still bounds WAIT ticks; it only continues through MARK_READY while polling remains within that timeout.\n\nExit codes: same as iterate (the final tick's action/reason decides the code).\n 0 CANCEL (merged or ready-delay elapsed)\n 10 WAIT (including a WAIT returned by --timeout)\n 11 MARK_READY\n 12 FIX_CODE\n 13 ESCALATE\n 14 CANCEL (closed without merging)\n 15 MERGE\n A command/validation/GitHub failure exits with a sysexits.h code instead (see docs/exit-codes.md).";
|
|
3
3
|
/** Public help page for the default PR polling invocation. */
|
|
4
4
|
export declare const DEFAULT_USAGE: string;
|
|
@@ -48,10 +48,11 @@ Usage:
|
|
|
48
48
|
pr-shepherd poll [PR] [poll-flags] [iterate-flags]
|
|
49
49
|
|
|
50
50
|
Poll flags:
|
|
51
|
-
--interval <duration> Sleep between WAIT ticks. Bare number = seconds. Default: 60s.
|
|
52
|
-
--timeout <duration> Maximum wall-clock wait for WAIT ticks. Bare number = seconds. Default: 4.5m.
|
|
53
|
-
--debounce <duration> Settle window after first FIX_CODE before returning. Bare number = seconds. Default: 60s. 0 disables.
|
|
54
|
-
--quiet-status
|
|
51
|
+
--interval <duration> Sleep between WAIT ticks. Bare number = seconds. Default: poll.intervalSeconds (built-in 60s).
|
|
52
|
+
--timeout <duration> Maximum wall-clock wait for WAIT ticks. Bare number = seconds. Default: poll.timeoutSeconds (built-in 4.5m).
|
|
53
|
+
--debounce <duration> Settle window after first FIX_CODE before returning. Bare number = seconds. Default: poll.debounceSeconds (built-in 60s). 0 disables.
|
|
54
|
+
--quiet-status Print only changed WAIT snapshots. Overrides poll.quietStatus.
|
|
55
|
+
--no-quiet-status Print every WAIT snapshot. Overrides poll.quietStatus.
|
|
55
56
|
--until-terminal Continue through WAIT/MARK_READY until FIX_CODE/CANCEL/ESCALATE.
|
|
56
57
|
|
|
57
58
|
Forwarded iterate flags:
|
|
@@ -67,7 +68,7 @@ Forwarded iterate flags:
|
|
|
67
68
|
Durations accept s/m/h suffixes: 30s, 4.5m, 1h. A bare number uses each flag's default unit (seconds
|
|
68
69
|
for --interval/--timeout/--debounce, minutes for --ready-delay/--stall-timeout); decimals are allowed only with
|
|
69
70
|
an explicit unit (4.5m).
|
|
70
|
-
Each WAIT tick writes an explicit still-running line to stderr by default; --quiet-status
|
|
71
|
+
Each WAIT tick writes an explicit still-running line to stderr by default; poll.quietStatus can change that default, --quiet-status/--no-quiet-status override it, and --verbose emits detailed per-tick lines.
|
|
71
72
|
FIX_CODE debounce writes a remaining-seconds line to stderr. --timeout does not cut an in-flight debounce short.
|
|
72
73
|
With --until-terminal, --timeout is ignored for WAIT ticks and polling continues until FIX_CODE, MERGE, CANCEL, or ESCALATE. With --merge, --timeout still bounds WAIT ticks; it only continues through MARK_READY while polling remains within that timeout.
|
|
73
74
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const TOP_USAGE = "pr-shepherd\n\nAutonomous PR CI monitor and review-comment resolver for agentic coding tools.\n\nUsage:\n pr-shepherd --version | -v\n pr-shepherd --help | -h\n pr-shepherd [PR] [poll-flags] [iterate-flags]\n pr-shepherd iterate [PR] [iterate-flags]\n pr-shepherd apply review [PR] [review-flags]\n pr-shepherd apply files [PR] [files...] [--tests] [--match REGEX]\n pr-shepherd apply journal [PR] <item> [--dry-run] [--format text|json]\n pr-shepherd journal extract --body-file <path>\n pr-shepherd build-suggestion-patches [PR] --thread-id ID --message MSG [groups...]\n pr-shepherd admin clean <pr|branch|current|repo|all> [value] [flags]\n pr-shepherd admin log-file [--format text|json]\n\nCommands:\n [PR] Poll until non-WAIT or timeout. This is the default command.\n iterate Run one iterate tick (single-tick alias).\n apply review Apply review-state mutations after fixes.\n apply files Mark selected changed files as viewed.\n apply journal Append a list item to the Shepherd Journal details block of a PR body.\n journal extract Extract a validated Shepherd Journal from a local PR-body file as JSON.\n build-suggestion-patches\n Convert ordered GitHub suggestion threads into patches and commit instructions.\n admin clean Remove pr-shepherd state files.\n admin log-file Print the per-worktree debug log path.\n\nPR argument:\n PR may be a number such as 42 or a GitHub pull request URL.\n When omitted, pr-shepherd infers the current branch's pull request.\n\nCommon flags:\n --format text|json Output Markdown text or JSON. Default: text.\n --verbose Include verbose iterate fields and detailed poll-tick lines.\n --help, -h Print help and exit before any GitHub, git, config, or log I/O.\n\nIterate flags:\n --ready-delay <duration> Settle window before a clean PR cancels. Bare number = minutes. Example: 15m.\n --stall-timeout <duration> Escalate repeated unchanged failures after this duration. Bare number = minutes. 0 disables.\n --no-auto-mark-ready Do not convert draft PRs to ready for review.\n --no-auto-cancel-actionable Legacy no-op; workflow runs are never cancelled.\n --merge Shepherd through readiness, then emit a merge or merge-queue command.\n\nPolling flags:\n --interval <duration> Delay between WAIT ticks. Bare number = seconds. Default: 60s.\n --timeout <duration> Poll wall-clock cap for WAIT ticks. Bare number = seconds. Default: 4.5m.\n --debounce <duration> Settle window after first FIX_CODE before returning. Bare number = seconds. Default: 60s. 0 disables.\n --quiet-status
|
|
1
|
+
export declare const TOP_USAGE = "pr-shepherd\n\nAutonomous PR CI monitor and review-comment resolver for agentic coding tools.\n\nUsage:\n pr-shepherd --version | -v\n pr-shepherd --help | -h\n pr-shepherd [PR] [poll-flags] [iterate-flags]\n pr-shepherd iterate [PR] [iterate-flags]\n pr-shepherd apply review [PR] [review-flags]\n pr-shepherd apply files [PR] [files...] [--tests] [--match REGEX]\n pr-shepherd apply journal [PR] <item> [--dry-run] [--format text|json]\n pr-shepherd journal extract --body-file <path>\n pr-shepherd build-suggestion-patches [PR] --thread-id ID --message MSG [groups...]\n pr-shepherd admin clean <pr|branch|current|repo|all> [value] [flags]\n pr-shepherd admin log-file [--format text|json]\n\nCommands:\n [PR] Poll until non-WAIT or timeout. This is the default command.\n iterate Run one iterate tick (single-tick alias).\n apply review Apply review-state mutations after fixes.\n apply files Mark selected changed files as viewed.\n apply journal Append a list item to the Shepherd Journal details block of a PR body.\n journal extract Extract a validated Shepherd Journal from a local PR-body file as JSON.\n build-suggestion-patches\n Convert ordered GitHub suggestion threads into patches and commit instructions.\n admin clean Remove pr-shepherd state files.\n admin log-file Print the per-worktree debug log path.\n\nPR argument:\n PR may be a number such as 42 or a GitHub pull request URL.\n When omitted, pr-shepherd infers the current branch's pull request.\n\nCommon flags:\n --format text|json Output Markdown text or JSON. Default: text.\n --verbose Include verbose iterate fields and detailed poll-tick lines.\n --help, -h Print help and exit before any GitHub, git, config, or log I/O.\n\nIterate flags:\n --ready-delay <duration> Settle window before a clean PR cancels. Bare number = minutes. Example: 15m.\n --stall-timeout <duration> Escalate repeated unchanged failures after this duration. Bare number = minutes. 0 disables.\n --no-auto-mark-ready Do not convert draft PRs to ready for review.\n --no-auto-cancel-actionable Legacy no-op; workflow runs are never cancelled.\n --merge Shepherd through readiness, then emit a merge or merge-queue command.\n\nPolling flags:\n --interval <duration> Delay between WAIT ticks. Bare number = seconds. Default: poll.intervalSeconds (built-in 60s).\n --timeout <duration> Poll wall-clock cap for WAIT ticks. Bare number = seconds. Default: poll.timeoutSeconds (built-in 4.5m).\n --debounce <duration> Settle window after first FIX_CODE before returning. Bare number = seconds. Default: poll.debounceSeconds (built-in 60s). 0 disables.\n --quiet-status Print only changed WAIT snapshots. Overrides poll.quietStatus.\n --no-quiet-status Print every WAIT snapshot. Overrides poll.quietStatus.\n --until-terminal Continue through WAIT/MARK_READY until FIX_CODE/CANCEL/ESCALATE.\n\nClean variants:\n pr [number] Remove state for one PR. Defaults to current branch PR.\n branch [name] Remove state for a branch's PR. Defaults to current branch.\n current Alias for branch against the current branch.\n repo Remove all state for the current repository.\n all Remove all pr-shepherd state.\n\nExit codes: 0 done, 10-19 PR state, 64-78 shepherd failed (sysexits.h).\n 0 CANCEL (merged or ready-delay elapsed)\n 10 WAIT\n 11 MARK_READY\n 12 FIX_CODE\n 13 ESCALATE\n 14 CANCEL (closed without merging)\n 15 MERGE\nSee docs/exit-codes.md for the full sysexits.h error-code table.\n\nDuration examples: 30s, 4.5m, 1h. A bare number uses each flag's default unit (see above); decimals are allowed with an explicit unit (4.5m).\n\nRun 'pr-shepherd <command> --help' for command-specific details.";
|
|
@@ -44,10 +44,11 @@ Iterate flags:
|
|
|
44
44
|
--merge Shepherd through readiness, then emit a merge or merge-queue command.
|
|
45
45
|
|
|
46
46
|
Polling flags:
|
|
47
|
-
--interval <duration> Delay between WAIT ticks. Bare number = seconds. Default: 60s.
|
|
48
|
-
--timeout <duration> Poll wall-clock cap for WAIT ticks. Bare number = seconds. Default: 4.5m.
|
|
49
|
-
--debounce <duration> Settle window after first FIX_CODE before returning. Bare number = seconds. Default: 60s. 0 disables.
|
|
50
|
-
--quiet-status
|
|
47
|
+
--interval <duration> Delay between WAIT ticks. Bare number = seconds. Default: poll.intervalSeconds (built-in 60s).
|
|
48
|
+
--timeout <duration> Poll wall-clock cap for WAIT ticks. Bare number = seconds. Default: poll.timeoutSeconds (built-in 4.5m).
|
|
49
|
+
--debounce <duration> Settle window after first FIX_CODE before returning. Bare number = seconds. Default: poll.debounceSeconds (built-in 60s). 0 disables.
|
|
50
|
+
--quiet-status Print only changed WAIT snapshots. Overrides poll.quietStatus.
|
|
51
|
+
--no-quiet-status Print every WAIT snapshot. Overrides poll.quietStatus.
|
|
51
52
|
--until-terminal Continue through WAIT/MARK_READY until FIX_CODE/CANCEL/ESCALATE.
|
|
52
53
|
|
|
53
54
|
Clean variants:
|
package/bin/cli/help.d.mts
CHANGED
|
@@ -194,7 +194,7 @@ Flags:
|
|
|
194
194
|
PR may be a number or GitHub pull request URL. When omitted, the current branch PR is inferred.
|
|
195
195
|
Exit code: 0 on success; nonzero on failure (sysexits.h — see docs/exit-codes.md).`;
|
|
196
196
|
readonly iterate: "pr-shepherd iterate\n\nRun one iterate tick for a pull request. The no-subcommand form polls; use this subcommand for a single tick.\nThe output contains one action and an action-specific ## Instructions section.\n\nUsage:\n pr-shepherd iterate [PR] [iterate-flags]\n\nIterate flags:\n --ready-delay <duration> Settle window before a clean PR cancels. Bare number = minutes. Example: 15m.\n --stall-timeout <duration> Escalate repeated unchanged failures after this duration. Bare number = minutes. 0 disables.\n --no-auto-mark-ready Do not convert draft PRs to ready for review.\n --no-auto-cancel-actionable Legacy no-op; workflow runs are never cancelled.\n --merge Shepherd through readiness, then emit a merge or merge-queue command.\n --format text|json Output Markdown text or JSON. Default: text.\n --verbose Include verbose iterate fields.\n --help, -h Print this help and exit before GitHub, git, config, or log I/O.\n\nDurations accept s/m/h suffixes: 30s, 4.5m, 1h. A bare number is minutes; decimals are allowed only with an explicit unit (4.5m).\n\nActions:\n WAIT No immediate action; continue with the next poll.\n MARK_READY Draft PR was marked ready; continue with the next poll.\n FIX_CODE Agent action is required; follow the instructions, then continue polling.\n CANCEL Stop polling: merged/closed or ready-delay elapsed.\n ESCALATE Stop polling until a human provides direction.\n MERGE Run the emitted merge/queue command, then continue monitoring.\n\nExit codes:\n 0 CANCEL (merged or ready-delay elapsed)\n 10 WAIT\n 11 MARK_READY\n 12 FIX_CODE\n 13 ESCALATE\n 14 CANCEL (closed without merging)\n 15 MERGE\n A command/validation/GitHub failure exits with a sysexits.h code instead (see docs/exit-codes.md).";
|
|
197
|
-
readonly poll: "pr-shepherd poll\n\nRun iterate repeatedly for WAIT ticks and during the FIX_CODE debounce window. Print only the\nfinal tick to stdout.\nPoll exits as soon as iterate returns MARK_READY, CANCEL, or ESCALATE, or when timeout\nreturns the last WAIT result. FIX_CODE starts a --debounce settle window (default 1m): poll keeps\niterating at --interval, then runs one more tick after the window and returns that result.\nWith --until-terminal or --merge, poll also continues through MARK_READY.\n\nUsage:\n pr-shepherd poll [PR] [poll-flags] [iterate-flags]\n\nPoll flags:\n --interval <duration> Sleep between WAIT ticks. Bare number = seconds. Default: 60s.\n --timeout <duration> Maximum wall-clock wait for WAIT ticks. Bare number = seconds. Default: 4.5m.\n --debounce <duration> Settle window after first FIX_CODE before returning. Bare number = seconds. Default: 60s. 0 disables.\n --quiet-status
|
|
197
|
+
readonly poll: "pr-shepherd poll\n\nRun iterate repeatedly for WAIT ticks and during the FIX_CODE debounce window. Print only the\nfinal tick to stdout.\nPoll exits as soon as iterate returns MARK_READY, CANCEL, or ESCALATE, or when timeout\nreturns the last WAIT result. FIX_CODE starts a --debounce settle window (default 1m): poll keeps\niterating at --interval, then runs one more tick after the window and returns that result.\nWith --until-terminal or --merge, poll also continues through MARK_READY.\n\nUsage:\n pr-shepherd poll [PR] [poll-flags] [iterate-flags]\n\nPoll flags:\n --interval <duration> Sleep between WAIT ticks. Bare number = seconds. Default: poll.intervalSeconds (built-in 60s).\n --timeout <duration> Maximum wall-clock wait for WAIT ticks. Bare number = seconds. Default: poll.timeoutSeconds (built-in 4.5m).\n --debounce <duration> Settle window after first FIX_CODE before returning. Bare number = seconds. Default: poll.debounceSeconds (built-in 60s). 0 disables.\n --quiet-status Print only changed WAIT snapshots. Overrides poll.quietStatus.\n --no-quiet-status Print every WAIT snapshot. Overrides poll.quietStatus.\n --until-terminal Continue through WAIT/MARK_READY until FIX_CODE/CANCEL/ESCALATE.\n\nForwarded iterate flags:\n --ready-delay <duration> Settle window before a clean PR cancels. Bare number = minutes. Example: 15m.\n --stall-timeout <duration> Escalate repeated unchanged failures after this duration. Bare number = minutes. 0 disables.\n --no-auto-mark-ready Do not convert draft PRs to ready for review.\n --no-auto-cancel-actionable Legacy no-op; workflow runs are never cancelled.\n --merge Shepherd through readiness, then emit a merge or merge-queue command.\n --format text|json Output Markdown text or JSON. Default: text.\n --verbose Include verbose iterate fields and detailed per-tick lines.\n --help, -h Print this help and exit before GitHub, git, config, or log I/O.\n\nDurations accept s/m/h suffixes: 30s, 4.5m, 1h. A bare number uses each flag's default unit (seconds\nfor --interval/--timeout/--debounce, minutes for --ready-delay/--stall-timeout); decimals are allowed only with\nan explicit unit (4.5m).\nEach WAIT tick writes an explicit still-running line to stderr by default; poll.quietStatus can change that default, --quiet-status/--no-quiet-status override it, and --verbose emits detailed per-tick lines.\nFIX_CODE debounce writes a remaining-seconds line to stderr. --timeout does not cut an in-flight debounce short.\nWith --until-terminal, --timeout is ignored for WAIT ticks and polling continues until FIX_CODE, MERGE, CANCEL, or ESCALATE. With --merge, --timeout still bounds WAIT ticks; it only continues through MARK_READY while polling remains within that timeout.\n\nExit codes: same as iterate (the final tick's action/reason decides the code).\n 0 CANCEL (merged or ready-delay elapsed)\n 10 WAIT (including a WAIT returned by --timeout)\n 11 MARK_READY\n 12 FIX_CODE\n 13 ESCALATE\n 14 CANCEL (closed without merging)\n 15 MERGE\n A command/validation/GitHub failure exits with a sysexits.h code instead (see docs/exit-codes.md).";
|
|
198
198
|
readonly clean: `pr-shepherd clean
|
|
199
199
|
|
|
200
200
|
Remove pr-shepherd state files from PR_SHEPHERD_STATE_DIR.
|
|
@@ -258,7 +258,7 @@ On POSIX, the final body-file path entry must be a readable regular file in a tr
|
|
|
258
258
|
symlinks, FIFOs, devices, and unreadable paths exit 66. Unsupported platforms fail closed with exit 66.
|
|
259
259
|
--help, -h Print this help and exit before any I/O.`;
|
|
260
260
|
readonly "log-file": "pr-shepherd log-file\n\nPrint the per-worktree append-only debug log path for the current repository.\nThe log is created by the first non-help pr-shepherd command that initializes logging.\n\nUsage:\n pr-shepherd log-file [--format text|json]\n\nFlags:\n --format text|json Print a raw path or {\"path\": \"...\"} JSON. Default: text.\n --help, -h Print this help and exit before logging setup.\n\nEnvironment:\n PR_SHEPHERD_LOG_DISABLED=1 disables logging.\n PR_SHEPHERD_STATE_DIR overrides the base state directory.\n\nExit code: 0 on success; 1 if repository identity cannot be resolved.";
|
|
261
|
-
readonly top: "pr-shepherd\n\nAutonomous PR CI monitor and review-comment resolver for agentic coding tools.\n\nUsage:\n pr-shepherd --version | -v\n pr-shepherd --help | -h\n pr-shepherd [PR] [poll-flags] [iterate-flags]\n pr-shepherd iterate [PR] [iterate-flags]\n pr-shepherd apply review [PR] [review-flags]\n pr-shepherd apply files [PR] [files...] [--tests] [--match REGEX]\n pr-shepherd apply journal [PR] <item> [--dry-run] [--format text|json]\n pr-shepherd journal extract --body-file <path>\n pr-shepherd build-suggestion-patches [PR] --thread-id ID --message MSG [groups...]\n pr-shepherd admin clean <pr|branch|current|repo|all> [value] [flags]\n pr-shepherd admin log-file [--format text|json]\n\nCommands:\n [PR] Poll until non-WAIT or timeout. This is the default command.\n iterate Run one iterate tick (single-tick alias).\n apply review Apply review-state mutations after fixes.\n apply files Mark selected changed files as viewed.\n apply journal Append a list item to the Shepherd Journal details block of a PR body.\n journal extract Extract a validated Shepherd Journal from a local PR-body file as JSON.\n build-suggestion-patches\n Convert ordered GitHub suggestion threads into patches and commit instructions.\n admin clean Remove pr-shepherd state files.\n admin log-file Print the per-worktree debug log path.\n\nPR argument:\n PR may be a number such as 42 or a GitHub pull request URL.\n When omitted, pr-shepherd infers the current branch's pull request.\n\nCommon flags:\n --format text|json Output Markdown text or JSON. Default: text.\n --verbose Include verbose iterate fields and detailed poll-tick lines.\n --help, -h Print help and exit before any GitHub, git, config, or log I/O.\n\nIterate flags:\n --ready-delay <duration> Settle window before a clean PR cancels. Bare number = minutes. Example: 15m.\n --stall-timeout <duration> Escalate repeated unchanged failures after this duration. Bare number = minutes. 0 disables.\n --no-auto-mark-ready Do not convert draft PRs to ready for review.\n --no-auto-cancel-actionable Legacy no-op; workflow runs are never cancelled.\n --merge Shepherd through readiness, then emit a merge or merge-queue command.\n\nPolling flags:\n --interval <duration> Delay between WAIT ticks. Bare number = seconds. Default: 60s.\n --timeout <duration> Poll wall-clock cap for WAIT ticks. Bare number = seconds. Default: 4.5m.\n --debounce <duration> Settle window after first FIX_CODE before returning. Bare number = seconds. Default: 60s. 0 disables.\n --quiet-status
|
|
261
|
+
readonly top: "pr-shepherd\n\nAutonomous PR CI monitor and review-comment resolver for agentic coding tools.\n\nUsage:\n pr-shepherd --version | -v\n pr-shepherd --help | -h\n pr-shepherd [PR] [poll-flags] [iterate-flags]\n pr-shepherd iterate [PR] [iterate-flags]\n pr-shepherd apply review [PR] [review-flags]\n pr-shepherd apply files [PR] [files...] [--tests] [--match REGEX]\n pr-shepherd apply journal [PR] <item> [--dry-run] [--format text|json]\n pr-shepherd journal extract --body-file <path>\n pr-shepherd build-suggestion-patches [PR] --thread-id ID --message MSG [groups...]\n pr-shepherd admin clean <pr|branch|current|repo|all> [value] [flags]\n pr-shepherd admin log-file [--format text|json]\n\nCommands:\n [PR] Poll until non-WAIT or timeout. This is the default command.\n iterate Run one iterate tick (single-tick alias).\n apply review Apply review-state mutations after fixes.\n apply files Mark selected changed files as viewed.\n apply journal Append a list item to the Shepherd Journal details block of a PR body.\n journal extract Extract a validated Shepherd Journal from a local PR-body file as JSON.\n build-suggestion-patches\n Convert ordered GitHub suggestion threads into patches and commit instructions.\n admin clean Remove pr-shepherd state files.\n admin log-file Print the per-worktree debug log path.\n\nPR argument:\n PR may be a number such as 42 or a GitHub pull request URL.\n When omitted, pr-shepherd infers the current branch's pull request.\n\nCommon flags:\n --format text|json Output Markdown text or JSON. Default: text.\n --verbose Include verbose iterate fields and detailed poll-tick lines.\n --help, -h Print help and exit before any GitHub, git, config, or log I/O.\n\nIterate flags:\n --ready-delay <duration> Settle window before a clean PR cancels. Bare number = minutes. Example: 15m.\n --stall-timeout <duration> Escalate repeated unchanged failures after this duration. Bare number = minutes. 0 disables.\n --no-auto-mark-ready Do not convert draft PRs to ready for review.\n --no-auto-cancel-actionable Legacy no-op; workflow runs are never cancelled.\n --merge Shepherd through readiness, then emit a merge or merge-queue command.\n\nPolling flags:\n --interval <duration> Delay between WAIT ticks. Bare number = seconds. Default: poll.intervalSeconds (built-in 60s).\n --timeout <duration> Poll wall-clock cap for WAIT ticks. Bare number = seconds. Default: poll.timeoutSeconds (built-in 4.5m).\n --debounce <duration> Settle window after first FIX_CODE before returning. Bare number = seconds. Default: poll.debounceSeconds (built-in 60s). 0 disables.\n --quiet-status Print only changed WAIT snapshots. Overrides poll.quietStatus.\n --no-quiet-status Print every WAIT snapshot. Overrides poll.quietStatus.\n --until-terminal Continue through WAIT/MARK_READY until FIX_CODE/CANCEL/ESCALATE.\n\nClean variants:\n pr [number] Remove state for one PR. Defaults to current branch PR.\n branch [name] Remove state for a branch's PR. Defaults to current branch.\n current Alias for branch against the current branch.\n repo Remove all state for the current repository.\n all Remove all pr-shepherd state.\n\nExit codes: 0 done, 10-19 PR state, 64-78 shepherd failed (sysexits.h).\n 0 CANCEL (merged or ready-delay elapsed)\n 10 WAIT\n 11 MARK_READY\n 12 FIX_CODE\n 13 ESCALATE\n 14 CANCEL (closed without merging)\n 15 MERGE\nSee docs/exit-codes.md for the full sysexits.h error-code table.\n\nDuration examples: 30s, 4.5m, 1h. A bare number uses each flag's default unit (see above); decimals are allowed with an explicit unit (4.5m).\n\nRun 'pr-shepherd <command> --help' for command-specific details.";
|
|
262
262
|
};
|
|
263
263
|
/** Resolve help keys for nested public commands before any command I/O. */
|
|
264
264
|
export declare function helpKeyForArgs(args: string[]): keyof typeof USAGE;
|
package/bin/cli/poll-handler.mjs
CHANGED
|
@@ -5,9 +5,7 @@ import { parseDurationToSeconds } from "./duration.mjs";
|
|
|
5
5
|
import { validateSecondsDurationFlag } from "./duration-flag.mjs";
|
|
6
6
|
import { parseIterateFlags } from "./iterate-flags.mjs";
|
|
7
7
|
import { emitIterateResult } from "./iterate-emitter.mjs";
|
|
8
|
-
|
|
9
|
-
const DEFAULT_POLL_TIMEOUT_SECONDS = 270;
|
|
10
|
-
const DEFAULT_POLL_DEBOUNCE_SECONDS = 60;
|
|
8
|
+
import { EXIT } from "../exit-codes.mjs";
|
|
11
9
|
export async function handlePoll(args) {
|
|
12
10
|
const { prNumber, global: globalOpts, extra } = parseCommonArgs(args);
|
|
13
11
|
const cfg = loadConfig();
|
|
@@ -18,17 +16,27 @@ export async function handlePoll(args) {
|
|
|
18
16
|
const intervalSuffix = validateSecondsDurationFlag("pr-shepherd", "--interval", intervalStr, hasFlag(extra, "--interval"));
|
|
19
17
|
if (intervalSuffix === null)
|
|
20
18
|
return;
|
|
21
|
-
const intervalSeconds = parseDurationToSeconds(intervalSuffix ?? "",
|
|
19
|
+
const intervalSeconds = parseDurationToSeconds(intervalSuffix ?? "", cfg.poll.intervalSeconds);
|
|
22
20
|
const timeoutStr = getFlag(extra, "--timeout");
|
|
23
21
|
const timeoutSuffix = validateSecondsDurationFlag("pr-shepherd", "--timeout", timeoutStr, hasFlag(extra, "--timeout"));
|
|
24
22
|
if (timeoutSuffix === null)
|
|
25
23
|
return;
|
|
26
|
-
const timeoutSeconds = parseDurationToSeconds(timeoutSuffix ?? "",
|
|
24
|
+
const timeoutSeconds = parseDurationToSeconds(timeoutSuffix ?? "", cfg.poll.timeoutSeconds);
|
|
27
25
|
const debounceStr = getFlag(extra, "--debounce");
|
|
28
26
|
const debounceSuffix = validateSecondsDurationFlag("pr-shepherd", "--debounce", debounceStr, hasFlag(extra, "--debounce"), { allowZero: true });
|
|
29
27
|
if (debounceSuffix === null)
|
|
30
28
|
return;
|
|
31
|
-
const debounceSeconds = parseDurationToSeconds(debounceSuffix ?? "",
|
|
29
|
+
const debounceSeconds = parseDurationToSeconds(debounceSuffix ?? "", cfg.poll.debounceSeconds, {
|
|
30
|
+
allowZero: true,
|
|
31
|
+
});
|
|
32
|
+
const quietStatusFlag = hasFlag(extra, "--quiet-status");
|
|
33
|
+
const noQuietStatusFlag = hasFlag(extra, "--no-quiet-status");
|
|
34
|
+
if (quietStatusFlag && noQuietStatusFlag) {
|
|
35
|
+
process.stderr.write("pr-shepherd: --quiet-status and --no-quiet-status cannot be used together\n");
|
|
36
|
+
process.exitCode = EXIT.USAGE;
|
|
37
|
+
return;
|
|
38
|
+
}
|
|
39
|
+
const quietStatus = quietStatusFlag || (!noQuietStatusFlag && cfg.poll.quietStatus);
|
|
32
40
|
const result = await runPoll({
|
|
33
41
|
...globalOpts,
|
|
34
42
|
prNumber,
|
|
@@ -40,7 +48,7 @@ export async function handlePoll(args) {
|
|
|
40
48
|
intervalSeconds,
|
|
41
49
|
timeoutSeconds,
|
|
42
50
|
debounceSeconds,
|
|
43
|
-
quietStatus
|
|
51
|
+
quietStatus,
|
|
44
52
|
untilTerminal: hasFlag(extra, "--until-terminal"),
|
|
45
53
|
});
|
|
46
54
|
emitIterateResult(result, {
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
import type { IterateResult } from "../../types.mts";
|
|
2
|
-
export declare function attachApiUsage(result: IterateResult, persistWarning: boolean, preservePersistedWarning?: boolean): Promise<IterateResult>;
|
|
2
|
+
export declare function attachApiUsage(result: IterateResult, persistWarning: boolean, preservePersistedWarning?: boolean, minimumPollIntervalMinutes?: number): Promise<IterateResult>;
|
|
@@ -5,7 +5,7 @@ import { buildQuotaAwareContinuation } from "../../quota-warning.mjs";
|
|
|
5
5
|
function shouldWarn(result) {
|
|
6
6
|
return ["wait", "mark_ready", "merge", "fix_code"].includes(result.action);
|
|
7
7
|
}
|
|
8
|
-
export async function attachApiUsage(result, persistWarning, preservePersistedWarning = false) {
|
|
8
|
+
export async function attachApiUsage(result, persistWarning, preservePersistedWarning = false, minimumPollIntervalMinutes = 0) {
|
|
9
9
|
const apiUsage = summarizeApiTelemetry();
|
|
10
10
|
if (apiUsage === undefined)
|
|
11
11
|
return result;
|
|
@@ -13,7 +13,11 @@ export async function attachApiUsage(result, persistWarning, preservePersistedWa
|
|
|
13
13
|
if (quotaWarning === undefined && apiUsage.graphql !== undefined && shouldWarn(result)) {
|
|
14
14
|
const [owner, repo] = result.repo.split("/");
|
|
15
15
|
if (owner && repo) {
|
|
16
|
-
|
|
16
|
+
const bands = loadConfig().watch.graphqlQuotaWarnings.map((band) => ({
|
|
17
|
+
...band,
|
|
18
|
+
pollIntervalMinutes: Math.max(band.pollIntervalMinutes, minimumPollIntervalMinutes),
|
|
19
|
+
}));
|
|
20
|
+
quotaWarning = await evaluateWorktreeGraphqlQuotaWarning({ owner, repo }, bands, apiUsage.graphql, persistWarning);
|
|
17
21
|
}
|
|
18
22
|
}
|
|
19
23
|
const { quotaWarning: _deferredWarning, ...baseResult } = result;
|
|
@@ -3,6 +3,6 @@ import { attachApiUsage } from "./api-usage.mjs";
|
|
|
3
3
|
export function withIterateApiUsage(opts, runCore) {
|
|
4
4
|
return withApiTelemetryScope(async () => {
|
|
5
5
|
const result = await runCore();
|
|
6
|
-
return attachApiUsage(result, opts.deferQuotaWarning !== true);
|
|
6
|
+
return attachApiUsage(result, opts.deferQuotaWarning !== true, false, opts.quotaWarningMinimumPollIntervalMinutes);
|
|
7
7
|
});
|
|
8
8
|
}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
import type { IterateResult } from "../types.mts";
|
|
2
|
-
export declare function withPollApiUsage(runCore: () => Promise<IterateResult>, preservePersistedWarning: boolean): Promise<IterateResult>;
|
|
2
|
+
export declare function withPollApiUsage(runCore: () => Promise<IterateResult>, preservePersistedWarning: boolean, minimumPollIntervalMinutes: number): Promise<IterateResult>;
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { withApiTelemetryScope } from "../github/api-telemetry.mjs";
|
|
2
2
|
import { attachApiUsage } from "./iterate/api-usage.mjs";
|
|
3
|
-
export function withPollApiUsage(runCore, preservePersistedWarning) {
|
|
3
|
+
export function withPollApiUsage(runCore, preservePersistedWarning, minimumPollIntervalMinutes) {
|
|
4
4
|
return withApiTelemetryScope(async () => {
|
|
5
5
|
const result = await runCore();
|
|
6
|
-
return attachApiUsage(result, true, preservePersistedWarning);
|
|
6
|
+
return attachApiUsage(result, true, preservePersistedWarning, minimumPollIntervalMinutes);
|
|
7
7
|
});
|
|
8
8
|
}
|
package/bin/commands/poll.mjs
CHANGED
|
@@ -9,7 +9,7 @@ const MAX_TIMER_MS = 2 ** 31 - 1;
|
|
|
9
9
|
const TIMER_DRIFT_TOLERANCE_MS = 500;
|
|
10
10
|
/** @deprecated Hidden implementation for the legacy `poll` alias. */
|
|
11
11
|
export function runPoll(opts) {
|
|
12
|
-
return withPollApiUsage(() => runPollCore(opts), opts.untilTerminal === true);
|
|
12
|
+
return withPollApiUsage(() => runPollCore(opts), opts.untilTerminal === true, opts.intervalSeconds / 60);
|
|
13
13
|
}
|
|
14
14
|
async function runPollCore(opts) {
|
|
15
15
|
const { intervalSeconds, timeoutSeconds, debounceSeconds: debounceSecondsOpt, quietStatus: quietStatusOpt, untilTerminal: untilTerminalOpt, ...iterateOpts } = opts;
|
|
@@ -45,6 +45,7 @@ async function runPollCore(opts) {
|
|
|
45
45
|
persistSeen: debounceSeconds === 0 || pastDebounce,
|
|
46
46
|
fingerprintCache,
|
|
47
47
|
deferQuotaWarning: !untilTerminal,
|
|
48
|
+
quotaWarningMinimumPollIntervalMinutes: intervalSeconds / 60,
|
|
48
49
|
});
|
|
49
50
|
const runTick = async (fingerprintCache) => {
|
|
50
51
|
try {
|
package/bin/config/load.d.mts
CHANGED
|
@@ -6,6 +6,12 @@ export interface GraphqlQuotaWarningBand {
|
|
|
6
6
|
remainingPercent: number;
|
|
7
7
|
pollIntervalMinutes: number;
|
|
8
8
|
}
|
|
9
|
+
interface PollConfig {
|
|
10
|
+
intervalSeconds: number;
|
|
11
|
+
timeoutSeconds: number;
|
|
12
|
+
debounceSeconds: number;
|
|
13
|
+
quietStatus: boolean;
|
|
14
|
+
}
|
|
9
15
|
export interface PrShepherdConfig {
|
|
10
16
|
/** Optional user classification configuration; preserved for rule consumers. */
|
|
11
17
|
classify?: unknown;
|
|
@@ -40,6 +46,7 @@ export interface PrShepherdConfig {
|
|
|
40
46
|
*/
|
|
41
47
|
resolveOtherHumanThreads: ResolveOtherHumanThreads;
|
|
42
48
|
};
|
|
49
|
+
poll: PollConfig;
|
|
43
50
|
watch: {
|
|
44
51
|
readyDelayMinutes: number;
|
|
45
52
|
graphqlQuotaWarnings: GraphqlQuotaWarningBand[];
|
package/bin/config/load.mjs
CHANGED
|
@@ -137,7 +137,30 @@ function parseMergeCommandArgs(value) {
|
|
|
137
137
|
}
|
|
138
138
|
return strategies.length === 0 ? [...value, "--merge"] : [...value];
|
|
139
139
|
}
|
|
140
|
-
function
|
|
140
|
+
function parsePollConfig(value) {
|
|
141
|
+
if (value === null || typeof value !== "object" || Array.isArray(value)) {
|
|
142
|
+
throw new Error("Invalid config: poll must be a plain object");
|
|
143
|
+
}
|
|
144
|
+
const record = value;
|
|
145
|
+
const intervalSeconds = parsePollDuration(record["intervalSeconds"], "intervalSeconds");
|
|
146
|
+
const timeoutSeconds = parsePollDuration(record["timeoutSeconds"], "timeoutSeconds");
|
|
147
|
+
const debounceSeconds = parsePollDuration(record["debounceSeconds"], "debounceSeconds", true);
|
|
148
|
+
const quietStatus = record["quietStatus"];
|
|
149
|
+
if (typeof quietStatus !== "boolean") {
|
|
150
|
+
throw new Error(`Invalid config: poll.quietStatus must be a boolean, got ${JSON.stringify(quietStatus)}`);
|
|
151
|
+
}
|
|
152
|
+
return { intervalSeconds, timeoutSeconds, debounceSeconds, quietStatus };
|
|
153
|
+
}
|
|
154
|
+
function parsePollDuration(value, key, allowZero = false) {
|
|
155
|
+
if (typeof value !== "number" ||
|
|
156
|
+
!Number.isFinite(value) ||
|
|
157
|
+
(allowZero ? value < 0 : value <= 0)) {
|
|
158
|
+
const range = allowZero ? "a non-negative" : "a positive";
|
|
159
|
+
throw new Error(`Invalid config: poll.${key} must be ${range} finite number, got ${JSON.stringify(value)}`);
|
|
160
|
+
}
|
|
161
|
+
return value;
|
|
162
|
+
}
|
|
163
|
+
function parseGraphqlQuotaWarnings(value, pollIntervalSeconds) {
|
|
141
164
|
if (!Array.isArray(value)) {
|
|
142
165
|
throw new Error("Invalid config: watch.graphqlQuotaWarnings must be an array");
|
|
143
166
|
}
|
|
@@ -149,22 +172,42 @@ function parseGraphqlQuotaWarnings(value) {
|
|
|
149
172
|
const record = item;
|
|
150
173
|
const remainingPercent = record["remainingPercent"];
|
|
151
174
|
const pollIntervalMinutes = record["pollIntervalMinutes"];
|
|
175
|
+
const pollIntervalFactor = record["pollIntervalFactor"];
|
|
152
176
|
if (typeof remainingPercent !== "number" ||
|
|
153
177
|
!Number.isInteger(remainingPercent) ||
|
|
154
178
|
remainingPercent < 1 ||
|
|
155
179
|
remainingPercent > 100) {
|
|
156
180
|
throw new Error(`Invalid config: watch.graphqlQuotaWarnings[${index}].remainingPercent must be an integer from 1 to 100`);
|
|
157
181
|
}
|
|
158
|
-
if (
|
|
159
|
-
|
|
160
|
-
|
|
182
|
+
if (pollIntervalMinutes === undefined && pollIntervalFactor === undefined) {
|
|
183
|
+
throw new Error(`Invalid config: watch.graphqlQuotaWarnings[${index}] must define pollIntervalMinutes, pollIntervalFactor, or both`);
|
|
184
|
+
}
|
|
185
|
+
if (pollIntervalMinutes !== undefined &&
|
|
186
|
+
(typeof pollIntervalMinutes !== "number" ||
|
|
187
|
+
!Number.isFinite(pollIntervalMinutes) ||
|
|
188
|
+
pollIntervalMinutes <= 0)) {
|
|
161
189
|
throw new Error(`Invalid config: watch.graphqlQuotaWarnings[${index}].pollIntervalMinutes must be a positive number`);
|
|
162
190
|
}
|
|
191
|
+
if (pollIntervalFactor !== undefined &&
|
|
192
|
+
(typeof pollIntervalFactor !== "number" ||
|
|
193
|
+
!Number.isFinite(pollIntervalFactor) ||
|
|
194
|
+
pollIntervalFactor < 1)) {
|
|
195
|
+
throw new Error(`Invalid config: watch.graphqlQuotaWarnings[${index}].pollIntervalFactor must be a number greater than or equal to 1`);
|
|
196
|
+
}
|
|
163
197
|
if (seen.has(remainingPercent)) {
|
|
164
198
|
throw new Error(`Invalid config: watch.graphqlQuotaWarnings has duplicate remainingPercent ${remainingPercent}`);
|
|
165
199
|
}
|
|
166
200
|
seen.add(remainingPercent);
|
|
167
|
-
|
|
201
|
+
const factorMinutes = typeof pollIntervalFactor === "number" ? (pollIntervalSeconds * pollIntervalFactor) / 60 : 0;
|
|
202
|
+
const absoluteMinutes = typeof pollIntervalMinutes === "number" ? pollIntervalMinutes : 0;
|
|
203
|
+
const resolvedPollIntervalMinutes = Math.max(absoluteMinutes, factorMinutes);
|
|
204
|
+
if (!Number.isFinite(resolvedPollIntervalMinutes)) {
|
|
205
|
+
throw new Error(`Invalid config: watch.graphqlQuotaWarnings[${index}] resolves to a non-finite poll interval`);
|
|
206
|
+
}
|
|
207
|
+
return {
|
|
208
|
+
remainingPercent,
|
|
209
|
+
pollIntervalMinutes: resolvedPollIntervalMinutes,
|
|
210
|
+
};
|
|
168
211
|
});
|
|
169
212
|
parsed.sort((left, right) => right.remainingPercent - left.remainingPercent);
|
|
170
213
|
for (let index = 1; index < parsed.length; index += 1) {
|
|
@@ -183,6 +226,7 @@ const KNOWN_CONFIG_KEYS = new Set([
|
|
|
183
226
|
"botUsernames",
|
|
184
227
|
"ignoreChecks",
|
|
185
228
|
"iterate",
|
|
229
|
+
"poll",
|
|
186
230
|
"watch",
|
|
187
231
|
"resolve",
|
|
188
232
|
"checks",
|
|
@@ -199,6 +243,7 @@ const KNOWN_NESTED_KEYS = {
|
|
|
199
243
|
"behindBaseHint",
|
|
200
244
|
"resolveOtherHumanThreads",
|
|
201
245
|
]),
|
|
246
|
+
poll: new Set(["intervalSeconds", "timeoutSeconds", "debounceSeconds", "quietStatus"]),
|
|
202
247
|
watch: new Set(["readyDelayMinutes", "graphqlQuotaWarnings"]),
|
|
203
248
|
resolve: new Set(["shaPoll"]),
|
|
204
249
|
checks: new Set(["ciTriggerEvents", "ignoreLogLines"]),
|
|
@@ -236,7 +281,23 @@ function warnUnknownConfigKeys(config) {
|
|
|
236
281
|
}
|
|
237
282
|
}
|
|
238
283
|
}
|
|
239
|
-
const
|
|
284
|
+
const rawDefaults = builtins;
|
|
285
|
+
function parseConfig(value, normalizeMergeArgs = true) {
|
|
286
|
+
const config = value;
|
|
287
|
+
config.botUsernames = parseBotUsernames(config.botUsernames);
|
|
288
|
+
config.ignoreChecks = parseIgnoreChecks(config.ignoreChecks);
|
|
289
|
+
config.actions.neverCancelRuns = parseNeverCancelRuns(config.actions.neverCancelRuns);
|
|
290
|
+
if (config.merge && normalizeMergeArgs) {
|
|
291
|
+
config.merge.commandArgs = parseMergeCommandArgs(config.merge.commandArgs);
|
|
292
|
+
}
|
|
293
|
+
config.poll = parsePollConfig(config.poll);
|
|
294
|
+
config.watch.graphqlQuotaWarnings = parseGraphqlQuotaWarnings(config.watch.graphqlQuotaWarnings, config.poll.intervalSeconds);
|
|
295
|
+
config.iterate.minimizeComments = parseMinimizeCommentsPolicy(config.iterate.minimizeComments);
|
|
296
|
+
config.iterate.resolveOtherHumanThreads = parseResolveOtherHumanThreads(config.iterate.resolveOtherHumanThreads);
|
|
297
|
+
config.checks.ignoreLogLines = parseIgnoreLogLines(config.checks.ignoreLogLines);
|
|
298
|
+
return config;
|
|
299
|
+
}
|
|
300
|
+
const defaults = parseConfig(structuredClone(rawDefaults), false);
|
|
240
301
|
const configCache = new Map();
|
|
241
302
|
function stripDeprecatedActionKeys(parsed) {
|
|
242
303
|
const rawActions = parsed.actions;
|
|
@@ -287,24 +348,14 @@ export function loadConfig() {
|
|
|
287
348
|
configCache.set(cwd, defaults);
|
|
288
349
|
return defaults;
|
|
289
350
|
}
|
|
290
|
-
const config = deepMerge(structuredClone(
|
|
291
|
-
config.botUsernames = parseBotUsernames(config.botUsernames);
|
|
292
|
-
config.ignoreChecks = parseIgnoreChecks(config.ignoreChecks);
|
|
293
|
-
config.actions.neverCancelRuns = parseNeverCancelRuns(config.actions.neverCancelRuns);
|
|
294
|
-
if (config.merge)
|
|
295
|
-
config.merge.commandArgs = parseMergeCommandArgs(config.merge.commandArgs);
|
|
296
|
-
config.watch.graphqlQuotaWarnings = parseGraphqlQuotaWarnings(config.watch.graphqlQuotaWarnings);
|
|
297
|
-
config.iterate.minimizeComments = parseMinimizeCommentsPolicy(config.iterate.minimizeComments);
|
|
298
|
-
config.iterate.resolveOtherHumanThreads = parseResolveOtherHumanThreads(config.iterate.resolveOtherHumanThreads);
|
|
299
|
-
config.checks.ignoreLogLines = parseIgnoreLogLines(config.checks.ignoreLogLines);
|
|
351
|
+
const config = parseConfig(deepMerge(structuredClone(rawDefaults), overlay));
|
|
300
352
|
configCache.set(cwd, config);
|
|
301
353
|
return config;
|
|
302
354
|
}
|
|
303
355
|
catch (err) {
|
|
304
356
|
process.stderr.write(`pr-shepherd: failed to parse ${rcPaths[0]}: ${err instanceof Error ? err.message : String(err)}\n`);
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
return fallback;
|
|
357
|
+
configCache.set(cwd, defaults);
|
|
358
|
+
return defaults;
|
|
308
359
|
}
|
|
309
360
|
}
|
|
310
361
|
/** Reset the config cache — for use in tests that change directories. */
|
package/bin/config.json
CHANGED
|
@@ -22,12 +22,18 @@
|
|
|
22
22
|
"behindBaseHint": "",
|
|
23
23
|
"resolveOtherHumanThreads": "none"
|
|
24
24
|
},
|
|
25
|
+
"poll": {
|
|
26
|
+
"intervalSeconds": 60,
|
|
27
|
+
"timeoutSeconds": 270,
|
|
28
|
+
"debounceSeconds": 60,
|
|
29
|
+
"quietStatus": false
|
|
30
|
+
},
|
|
25
31
|
"watch": {
|
|
26
32
|
"readyDelayMinutes": 10,
|
|
27
33
|
"graphqlQuotaWarnings": [
|
|
28
|
-
{ "remainingPercent": 30, "
|
|
29
|
-
{ "remainingPercent": 20, "
|
|
30
|
-
{ "remainingPercent": 10, "
|
|
34
|
+
{ "remainingPercent": 30, "pollIntervalFactor": 2 },
|
|
35
|
+
{ "remainingPercent": 20, "pollIntervalFactor": 5 },
|
|
36
|
+
{ "remainingPercent": 10, "pollIntervalFactor": 10 }
|
|
31
37
|
]
|
|
32
38
|
},
|
|
33
39
|
"resolve": {
|
package/bin/quota-warning.mjs
CHANGED
|
@@ -2,5 +2,5 @@ export function buildQuotaAwareContinuation(warning, prefix) {
|
|
|
2
2
|
const interval = `${warning.pollIntervalMinutes}m`;
|
|
3
3
|
const timeout = `${warning.pollTimeoutMinutes}m`;
|
|
4
4
|
const resetTime = new Date(warning.resetAt * 1000).toISOString();
|
|
5
|
-
return `${prefix} GitHub's GraphQL API quota is low (crossed the ${warning.thresholdPercent}% remaining threshold). Keep using pr-shepherd at the cadence below; for incidental PR operations that do not need Shepherd's full snapshot, prefer non-GraphQL \`gh\` CLI commands (e.g. \`gh pr view\`, \`gh pr review\`, \`gh api\` REST endpoints) — they draw on the separate REST budget, not the depleted GraphQL pool. Do not substitute \`gh pr checks\` or \`gh pr watch\` for the Shepherd loop. Resume full-cadence pr-shepherd after the GraphQL quota resets at ${resetTime}. If you must keep polling before then, poll no more often than every ${warning.pollIntervalMinutes} minutes. With a polling CLI command, preserve the other options,
|
|
5
|
+
return `${prefix} GitHub's GraphQL API quota is low (crossed the ${warning.thresholdPercent}% remaining threshold). Keep using pr-shepherd at the cadence below; for incidental PR operations that do not need Shepherd's full snapshot, prefer non-GraphQL \`gh\` CLI commands (e.g. \`gh pr view\`, \`gh pr review\`, \`gh api\` REST endpoints) — they draw on the separate REST budget, not the depleted GraphQL pool. Do not substitute \`gh pr checks\` or \`gh pr watch\` for the Shepherd loop. Resume full-cadence pr-shepherd after the GraphQL quota resets at ${resetTime}. If you must keep polling before then, poll no more often than every ${warning.pollIntervalMinutes} minutes. With a polling CLI command, preserve the other options, raise any shorter interval and timeout flags to at least \`--interval ${interval} --timeout ${timeout}\`, keep any longer cadence, and omit \`--timeout\` when using \`--until-terminal\`. With a single-tick CLI, API, or MCP call, wait at least ${warning.pollIntervalMinutes} minutes before the next tick.`;
|
|
6
6
|
}
|
package/bin/types/iterate.d.mts
CHANGED
|
@@ -153,10 +153,10 @@ export interface IterateCommandOptions extends GlobalOptions {
|
|
|
153
153
|
/** Shepherd through readiness and emit the exact merge/queue command when ready. */
|
|
154
154
|
merge?: boolean;
|
|
155
155
|
/**
|
|
156
|
-
* Internal. Defers
|
|
157
|
-
*
|
|
158
|
-
* api.mts.
|
|
156
|
+
* Internal. Defers quota warnings until an until-terminal poll breaks. Set only by
|
|
157
|
+
* `runPollCore`; excluded from the public `IterateInput` in api.mts.
|
|
159
158
|
*/
|
|
160
159
|
deferQuotaWarning?: boolean;
|
|
160
|
+
quotaWarningMinimumPollIntervalMinutes?: number;
|
|
161
161
|
}
|
|
162
162
|
export {};
|
package/package.json
CHANGED