|
| 1 | +version = 1 |
| 2 | + |
| 3 | +[merge] |
| 4 | +# Label to enable Kodiak to merge a PR. |
| 5 | +automerge_label = "automerge" |
| 6 | + |
| 7 | +# When disabled, Kodiak will immediately attempt to merge any PR that passes all |
| 8 | +# GitHub branch protection requirements. |
| 9 | +require_automerge_label = true |
| 10 | + |
| 11 | +# If you're using the "Require signed commits" GitHub Branch Protection setting |
| 12 | +# to require commit signatures, "merge" or "squash" are the only compatible options. "rebase" will cause Kodiak to raise a configuration error. |
| 13 | +method = "squash" # default: "merge", options: "merge", "squash", "rebase" |
| 14 | + |
| 15 | +# Once a PR is merged, delete the branch. This option behaves like the GitHub |
| 16 | +# repository setting "Automatically delete head branches", which automatically |
| 17 | +# deletes head branches after pull requests are merged. |
| 18 | +delete_branch_on_merge = true # default: false |
| 19 | + |
| 20 | +# If there is a merge conflict, make a comment on the PR and remove the |
| 21 | +# automerge label. This option only applies when `merge.require_automerge_label` |
| 22 | +# is enabled. |
| 23 | +notify_on_conflict = true # default: true |
| 24 | + |
| 25 | +# Don't wait for in-progress status checks on a PR to finish before updating the |
| 26 | +# branch. |
| 27 | +optimistic_updates = true # default: true |
| 28 | + |
| 29 | +# If a PR is passing all checks and is able to be merged, merge it without |
| 30 | +# placing it in the merge queue. This option adds some unfairness where PRs |
| 31 | +# waiting in the queue the longest are not served first. |
| 32 | +prioritize_ready_to_merge = true # default: false |
| 33 | + |
| 34 | +# Never merge a PR. This option can be used with `update.always` to |
| 35 | +# automatically update a PR without merging. |
| 36 | +do_not_merge = false # default: false |
| 37 | + |
| 38 | +[merge.message] |
| 39 | +# By default (`"github_default"`), GitHub uses the title of a PR's first commit |
| 40 | +# for the merge commit title. `"pull_request_title"` uses the PR title for the |
| 41 | +# merge commit. |
| 42 | +title = "pull_request_title" # default: "github_default", options: "github_default", "pull_request_title" |
| 43 | + |
| 44 | +# By default (`"github_default"`), GitHub combines the titles of a PR's commits |
| 45 | +# to create the body text of a merge commit. `"pull_request_body"` uses the |
| 46 | +# content of the PR to generate the body content while `"empty"` sets an empty |
| 47 | +# body. |
| 48 | +body = "pull_request_body" # default: "github_default", options: "github_default", "pull_request_body", "empty" |
| 49 | + |
| 50 | +# Append the Pull Request URL to the merge message. Makes navigating to the PR |
| 51 | +# from the commit easier. |
| 52 | +#### NOTE: 'true' required for benchmarks in CI: |
| 53 | +include_pull_request_url = false # default: false |
| 54 | + |
| 55 | +# Add the PR number to the merge commit title. This setting replicates GitHub's |
| 56 | +# behavior of automatically adding the PR number to the title of merges created |
| 57 | +# through the UI. This option only applies when `merge.message.title` does not |
| 58 | +# equal `"github_default"`. |
| 59 | +### NOTE: if this is set to true github links to unrelated OSS issues, which is confusing |
| 60 | +include_pr_number = true # default: true |
| 61 | + |
| 62 | +# Control the text used in the merge commit. The GitHub default is markdown, but |
| 63 | +# `"plain_text"` or `"html"` can be used to render the pull request body as text |
| 64 | +# or HTML. This option only applies when `merge.message.body = "pull_request_body"`. |
| 65 | +body_type = "markdown" # default: "markdown", options: "plain_text", "markdown", "html" |
| 66 | + |
| 67 | +# Strip HTML comments (`<!-- some HTML comment -->`) from merge commit body. |
| 68 | +# This setting is useful for stripping HTML comments created by PR templates. |
| 69 | +# This option only applies when `merge.message.body_type = "markdown"`. |
| 70 | +strip_html_comments = true # default: false |
| 71 | + |
| 72 | +# Remove all content before the configured string in the pull request body. |
| 73 | +# This setting is useful when we want to include only a part of the pull request |
| 74 | +# description as the commit message. |
| 75 | +# This option only applies when `merge.message.body_type = "markdown"`. |
| 76 | +cut_body_before = "<!-- kodiak-commit-message-body-start: do not remove/edit this line -->" |
| 77 | + |
| 78 | +include_coauthors = true |
| 79 | + |
| 80 | +[update] |
| 81 | + |
| 82 | +# Update a PR whenever out of date with the base branch. The PR will be updated |
| 83 | +# regardless of merge requirements (e.g. failing status checks, missing reviews, |
| 84 | +# blacklist labels). |
| 85 | +# |
| 86 | +# Kodiak will only update PRs with the `merge.automerge_label` label or if |
| 87 | +# `update.require_automerge_label = false`. |
| 88 | +# |
| 89 | +# When enabled, _Kodiak will not be able to efficiently update PRs._ If you have |
| 90 | +# multiple PRs against a target like `master`, any time a commit is added to |
| 91 | +# `master` _all_ of those PRs against `master` will update. For `N` PRs against |
| 92 | +# a target you will see at least `N(N-1)/2` updates. If this configuration |
| 93 | +# option was disabled you would only see at least `N-1` updates. |
| 94 | +always = false # default: false |
| 95 | + |
| 96 | +# When enabled, Kodiak will only update PRs that have an automerge label |
| 97 | +# (configured via `merge.automerge_label`). When disable, Kodiak will update any |
| 98 | +# PR. This option only applies when `update.always = true`. |
| 99 | +require_automerge_label = true # default: true |
0 commit comments