Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,10 @@ Install `examples/github-workflow.yml` on the default branch. It reacts to
deploy labels, ready/synchronize events, reviews, named CI `workflow_run`
completions, and completed external check suites. Keep its `workflows` list
aligned with `pipeline.ci_workflows`. The privileged worker never checks out or
executes pull-request code. Pin the Action to the full reviewed release commit:
executes pull-request code. The Action follows releases by default so the same
serialized worker can dispatch deployment when GitHub suppresses the
`workflow_run` event for token-dispatched CI. Pin the Action to the full
reviewed release commit:

```yaml
- uses: Forward-Future/DeployBot@13d7293b181581d2e4d59d8a605df76f7feb88a6
Expand Down Expand Up @@ -155,6 +158,10 @@ work, and creates integration PRs when configured. A conflict produces a repair
handoff containing the source thread, base/head SHAs, source paths, and one
return command:

In `overlap` mode, a ready source waits when another active, near-ready intent
belongs to the same source-overlap component. Unrelated ready work still drains,
and the held component freezes together once its remaining gates pass.

```bash
deploybot resume <pr-number>
```
Expand All @@ -168,6 +175,9 @@ can pause further merges until `deploybot unpause`.
[pipeline]
ci_workflows = ["CI"]
deploy_workflows = ["Deploy"]
batch_settle_seconds = 15
ci_failure_grace_seconds = 90
promotion_workers = 4
ready_to_merge_target_minutes = 15
merge_to_live_target_minutes = 10
auto_promote = true
Expand All @@ -184,6 +194,10 @@ expected_status = 200
mode = "overlap"
```

For `overlap` or `all` mode with the hosted coordinator, enable **Allow GitHub
Actions to create and approve pull requests** under the repository's Actions
workflow-permission settings. `deploybot doctor` reports this prerequisite.

## Review providers

Required checks are always exact-head gates. Optional providers use normalized
Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ inputs:
follow:
description: Follow cumulative main through CI and deployment
required: false
default: "false"
default: "true"
dispatch_ci:
description: Dispatch configured CI after a merge made with github.token
required: false
Expand Down
3 changes: 3 additions & 0 deletions docs/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,9 @@ Provider fields are:
| `thread_active_hours` | Positive integer; default 72. |
| `ci_workflows` | Workflow names followed as exact-main CI. Default: `["CI"]`. |
| `deploy_workflows` | Deployment workflow names. Default: `["Deploy"]`. |
| `batch_settle_seconds` | Non-negative window for coalescing near-ready deploy requests before freezing a batch. Default: 15. |
| `ci_failure_grace_seconds` | Non-negative window for an exact-main CI retry to replace a failed attempt before the release fails. Default: 90. |
| `promotion_workers` | Positive maximum number of deploy requests promoted concurrently. Default: 4. |
| `ready_to_merge_target_minutes` | Positive timing target; default 15. |
| `merge_to_live_target_minutes` | Positive timing target; default 10. |
| `auto_promote` | Default `true`. |
Expand Down
Loading