0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-11-30 19:03:43 -05:00
forgejo-docs/docs/user/merge-message-templates.md
Earl Warren f89d4d568d sync with Gitea e865de1e9d65dc09797d165a51c8e705d2a86030
cd docs
git diff d3982bcd814bac93e3cbce1c7eb749b17e413fbd..e865de1e9d65dc09797d165a51c8e705d2a86030 -- $(find . -type f -name '*en-us*')

(cherry picked from commit 6aa9b491a0)
2024-04-23 07:16:28 +00:00

1.8 KiB

title license origin_url
Merge Message templates Apache-2.0 e865de1e9d/docs/content/usage/merge-message-templates.en-us.md

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 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

Rebase

When rebasing without a merge commit, REBASE_TEMPLATE.md modifies the message of the last commit. The following additional variables are available in this template:

  • CommitTitle: Commit's title
  • CommitBody: Commits's body text