earl-warren/docs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request 'import usage/merge-message-templates.en-us.md' (#171) from dachary/website:wip-merge-templates into main

Browse source 
Reviewed-on: https://codeberg.org/forgejo/website/pulls/171
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
This commit is contained in:
Loïc Dachary 2023-03-10 12:13:57 +00:00
commit a660ad174e
2 changed files with 35 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
v1.19/user/index.md
View file

@ -27,6 +27,7 @@ involved in running it on their machines.
- [Branch and tag protection](protection)
- Advanced Usage
- [Issue and Pull Request Templates](issue-pull-request-templates)
- [Merge Message templates](merge-message-templates)
- [Generating an Access Token](https://docs.codeberg.org/advanced/access-token/)
- [Webhooks](webhooks)
- Authentication

34
v1.19/user/merge-message-templates.md Normal file
View file

@ -0,0 +1,34 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Merge Message templates'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/699f20234b9f7cdbbeeee3be004470c598fa1147/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](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`