2023-03-09 01:41:08 -05:00
|
|
|
---
|
2023-03-09 01:43:38 -05:00
|
|
|
layout: '~/layouts/Markdown.astro'
|
|
|
|
|
title: 'Merge Message templates'
|
|
|
|
|
license: 'Apache-2.0'
|
2023-04-28 10:02:55 -04:00
|
|
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e8433b7fe6dd1dfa5ecf0633568cc3e34caeb0f9/docs/content/doc/usage/merge-message-templates.en-us.md'
|
2023-03-09 01:41:08 -05:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## File names
|
|
|
|
|
|
|
|
|
|
Possible file names for PR default merge message templates:
|
|
|
|
|
|
|
|
|
|
- `.gitea/default_merge_message/MERGE_TEMPLATE.md`
|
|
|
|
|
- `.gitea/default_merge_message/REBASE_TEMPLATE.md`
|
|
|
|
|
- `.gitea/default_merge_message/REBASE-MERGE_TEMPLATE.md`
|
|
|
|
|
- `.gitea/default_merge_message/SQUASH_TEMPLATE.md`
|
|
|
|
|
- `.gitea/default_merge_message/MANUALLY-MERGED_TEMPLATE.md`
|
|
|
|
|
- `.gitea/default_merge_message/REBASE-UPDATE-ONLY_TEMPLATE.md`
|
|
|
|
|
|
|
|
|
|
## Variables
|
|
|
|
|
|
|
|
|
|
You can use the following variables enclosed in `${}` inside these templates which follow [os.Expand](https://pkg.go.dev/os#Expand) syntax:
|
|
|
|
|
|
|
|
|
|
- BaseRepoOwnerName: Base repository owner name of this pull request
|
|
|
|
|
- BaseRepoName: Base repository name of this pull request
|
|
|
|
|
- BaseBranch: Base repository target branch name of this pull request
|
|
|
|
|
- HeadRepoOwnerName: Head repository owner name of this pull request
|
|
|
|
|
- HeadRepoName: Head repository name of this pull request
|
|
|
|
|
- HeadBranch: Head repository branch name of this pull request
|
|
|
|
|
- PullRequestTitle: Pull request's title
|
|
|
|
|
- PullRequestDescription: Pull request's description
|
|
|
|
|
- PullRequestPosterName: Pull request's poster name
|
|
|
|
|
- PullRequestIndex: Pull request's index number
|
|
|
|
|
- PullRequestReference: Pull request's reference char with index number. i.e. #1, !2
|
|
|
|
|
- ClosingIssues: return a string contains all issues which will be closed by this pull request i.e. `close #1, close #2`
|
