foster/forgejo-docs
0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-12-26 22:51:22 -05:00
Code Issues Activity
forgejo-docs/user/merge-message-templates.md
Earl Warren 121a25e25e
docs: v1.20: sync Gitea 62ac3251fa545d32bdfc9ff824106b97ec63edbb 
# Conflicts:
#	user/packages/alpine.md
#	user/packages/cran.md
#	user/packages/debian.md
#	user/packages/go.md
#	user/packages/rpm.md
2023-08-13 14:13:15 +01:00

1.8 KiB
Raw Blame History

layout title license origin_url
~/layouts/Markdown.astro Merge Message templates Apache-2.0 62ac3251fa/docs/content/doc/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