Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc merge message limitations #802

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

doc merge message limitations #802

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cbfd920
doc merge message limitations
chdsbd Apr 14, 2022
568fde2
wip
chdsbd Apr 14, 2022
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
22 changes: 22 additions & 0 deletions docs/docs/config-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,8 @@ Never merge a PR. This option can be used with `update.always` to automatically
- **default:** `"github_default"`
- **options:** `"github_default"`, `"pull_request_title"`

> **NOTE:** This configuration option doesn't work with the `"rebase"` merge method.

By default (`"github_default"`), the title depends on [merge.method](config-reference.md#mergemethod):

- In case of `"merge"`, GitHub will create a merge commit title of the form, `Merge pull request #X from Y/Z`.
Expand All @@ -301,6 +303,8 @@ For `"pull_request_title"`, Kodiak uses the pull request title for both merge an
- **default:** `"github_default"`
- **options:** `"github_default"`, `"pull_request_body"`, `"empty"`

> **NOTE:** This configuration option doesn't work with the `"rebase"` merge method.

By default (`"github_default"`), GitHub combines the titles of a PR's commits to create the body
text of a merge commit. `"pull_request_body"` uses the content of the PR to generate
the body content while `"empty"` sets an empty body.
Expand All @@ -310,6 +314,8 @@ the body content while `"empty"` sets an empty body.
- **type:** `boolean`
- **default:** `true`

> **NOTE:** This configuration option doesn't work with the `"rebase"` merge method.

Add the PR number to the merge commit title.

This setting replicates GitHub's behavior of automatically adding the PR number to the title of merges created through the UI.
Expand All @@ -322,6 +328,8 @@ This option only applies when `merge.message.title` does not equal `"github_defa
- **default:** `"markdown"`
- **options:** `"markdown"`, `"plain_text"`, `"html"`

> **NOTE:** This configuration option doesn't work with the `"rebase"` merge method.

Control the text used in the merge commit. The GitHub default is markdown, but `"plain_text"` or `"html"` can be used to render the pull request body as text or HTML.

This option only applies when `merge.message.body = "pull_request_body"`.
Expand All @@ -331,6 +339,8 @@ This option only applies when `merge.message.body = "pull_request_body"`.
- **type:** `boolean`
- **default:** `false`

> **NOTE:** This configuration option doesn't work with the `"rebase"` merge method.

Strip HTML comments (`<!-- some HTML comment -->`) from merge commit body.

This setting is useful for stripping HTML comments created by PR templates.
Expand All @@ -342,6 +352,8 @@ This option only applies when `merge.message.body_type = "markdown"`.
- **type:** `string`
- **default:** `null`

> **NOTE:** This configuration option doesn't work with the `"rebase"` merge method.

Remove all content _before_ the configured string in the pull request body.

This setting is useful when we want to include only a part of the pull request description as the commit message.
Expand All @@ -353,6 +365,8 @@ This option only applies when `merge.message.body_type = "markdown"`.
- **type:** `string`
- **default:** `null`

> **NOTE:** This configuration option doesn't work with the `"rebase"` merge method.

Remove all content _after_ the configured string in the pull request body.

This setting is useful when we want to include only a part of the pull request description as the commit message.
Expand All @@ -364,6 +378,8 @@ This option only applies when `merge.message.body_type = "markdown"`.
- **type:** `boolean`
- **default:** `False`

> **NOTE:** This configuration option doesn't work with the `"rebase"` merge method.

Remove the string used to handle body in `cut_body_before` and `cut_body_after`.

This setting is useful if you believe that the separator doesn't belong in the commit message.
Expand All @@ -375,6 +391,8 @@ This option only applies if `cut_body_after` or `cut_body_before` is in use.
- **type:** `boolean`
- **default:** `false`

> **NOTE:** This configuration option doesn't work with the `"rebase"` merge method.

If a PR includes commits authored by other users, add those users as coauthors to the pull request.

Coauthors are added using the [`Co-authored-by` trailer syntax](https://help.github.com/en/github/committing-changes-to-your-project/creating-a-commit-with-multiple-authors#creating-co-authored-commits-on-github).
Expand All @@ -400,6 +418,8 @@ Co-authored-by: Steve Dignam <[email protected]>
- **type:** `boolean`
- **default:** `false`

> **NOTE:** This configuration option doesn't work with the `"rebase"` merge method.

Add the pull request author as a coauthor of the merge commit using `Co-authored-by: jdoe <[email protected]>` syntax.

This setting only applies when `merge.message.body = "pull_request"` is set.
Expand All @@ -413,6 +433,8 @@ March 6th, 2020, making this option no longer necessary.
- **type:** `boolean`
- **default:** `false`

> **NOTE:** This configuration option doesn't work with the `"rebase"` merge method.

Append the pull request's URL to the commit message body, prefixed with `PR-URL:`.

This can make accessing the relevant PR for a given commit easier.
Expand Down