跳至主要内容
版本：1.24.7

从模板建立工單与合並請求

开发者可以利用问题模板建立工單与合並請求，其目的在于规范参与者的语言表达。

模板介绍​

Gitea 支持两种格式的模板：Markdown 和 YAML。

Markdown 模板​

在 Gitea 中存在两种用途的 Markdown 模板：

  • ISSUE_TEMPLATE/bug-report.md 用于规范工單的 Markdown 文本描述
  • PULL_REQUEST_TEMPLATE.md 用于规范合並請求的 Markdown 文本描述

對於以上 Markdown 模板，我们推荐您将它们放置到项目目錄 .gitea 進行收纳。

YAML 模板​

用 YAML 语法编写的模板相比 Markdown 可以实現更丰富的功能，利用表單实現诸如：问卷调查、字符校验。在 Gitea 中的 YAML 同样支持两种用途：

  • ISSUE_TEMPLATE/bug-report.yaml 用于建立问卷调查形式的工單
  • PULL_REQUEST_TEMPLATE.yaml 用于建立表單形式的合並請求

對於以上 YAML 模板，我们同样推荐您将它们放置到项目目錄 .gitea 進行收纳。

表單支持通過 URL 查询參數传值​

当新建工單页面 URL 以 ?title=Issue+Title&body=Issue+Text 為查询參數，表單将使用其中的參數（key-value）填充表單内容。

Gitea 支持的模板文件路径​

工單模板文件名:

  • ISSUE_TEMPLATE.md
  • ISSUE_TEMPLATE.yaml
  • ISSUE_TEMPLATE.yml
  • issue_template.md
  • issue_template.yaml
  • issue_template.yml
  • .gitea/ISSUE_TEMPLATE.md
  • .gitea/ISSUE_TEMPLATE.yaml
  • .gitea/ISSUE_TEMPLATE.yml
  • .gitea/issue_template.md
  • .gitea/issue_template.yaml
  • .gitea/issue_template.yml
  • .github/ISSUE_TEMPLATE.md
  • .github/ISSUE_TEMPLATE.yaml
  • .github/ISSUE_TEMPLATE.yml
  • .github/issue_template.md
  • .github/issue_template.yaml
  • .github/issue_template.yml

合並請求模板:

  • PULL_REQUEST_TEMPLATE.md
  • PULL_REQUEST_TEMPLATE.yaml
  • PULL_REQUEST_TEMPLATE.yml
  • pull_request_template.md
  • pull_request_template.yaml
  • pull_request_template.yml
  • .gitea/PULL_REQUEST_TEMPLATE.md
  • .gitea/PULL_REQUEST_TEMPLATE.yaml
  • .gitea/PULL_REQUEST_TEMPLATE.yml
  • .gitea/pull_request_template.md
  • .gitea/pull_request_template.yaml
  • .gitea/pull_request_template.yml
  • .github/PULL_REQUEST_TEMPLATE.md
  • .github/PULL_REQUEST_TEMPLATE.yaml
  • .github/PULL_REQUEST_TEMPLATE.yml
  • .github/pull_request_template.md
  • .github/pull_request_template.yaml
  • .github/pull_request_template.yml

工單模板目錄​

由于工單存在多种類型，Gitea 支持将工單模板统一收纳到 ISSUE_TEMPLATE 目錄。以下是 Gitea 支持的工單模板目錄:

  • ISSUE_TEMPLATE
  • issue_template
  • .gitea/ISSUE_TEMPLATE
  • .gitea/issue_template
  • .github/ISSUE_TEMPLATE
  • .github/issue_template
  • .gitlab/ISSUE_TEMPLATE
  • .gitlab/issue_template

目錄支持混合存放 Markdown (.md) 或 YAML (.yaml/.yml) 格式的工單模板。另外，合並請求模板不支持目錄存放。

Markdown 模板语法​

---
name: "Template Name"
about: "This template is for testing!"
title: "[TEST] "
ref: "main"
labels:
  - bug
  - "help needed"
---

This is the template!

上面的示例表示使用者从列表中選择一个工單模板时，列表会展示模板名稱 Template Name 和模板描述 This template is for testing!。 同时，标题会预先填充為 [TEST]，而正文将预先填充 This is the template!。該 Issue 会被指派给 user1。 最后，Issue 還会被分配两个標籤，bug 和 help needed，並且将问题指向 main 分支。

YAML 模板语法​

YAML 模板格式如下，相比 Markdown 模板提供了更多实用性的功能。

name: 表單名稱
about: 表單描述
title: 默认标题
body: 主體内容
  type: 定义表單元素類型
    id: 定义表單标号
    attributes: 扩展的属性
    validations: 内容校验

下例 YAML 配置文件完整定义了一个用于提交 bug 的问卷调查。

name: Bug Report
about: File a bug report
title: "[Bug]: "
body:
  - type: markdown
    attributes:
      value: |
        Thanks for taking the time to fill out this bug report!
  - type: input
    id: contact
    attributes:
      label: Contact Details
      description: How can we get in touch with you if we need more info?
      placeholder: ex. email@example.com
    validations:
      required: false
  - type: textarea
    id: what-happened
    attributes:
      label: What happened?
      description: Also tell us, what did you expect to happen?
      placeholder: Tell us what you see!
      value: "A bug happened!"
    validations:
      required: true
  - type: dropdown
    id: version
    attributes:
      label: Version
      description: What version of our software are you running?
      options:
        - 1.0.2 (Default)
        - 1.0.3 (Edge)
    validations:
      required: true
  - type: dropdown
    id: browsers
    attributes:
      label: What browsers are you seeing the problem on?
      multiple: true
      options:
        - Firefox
        - Chrome
        - Safari
        - Microsoft Edge
  - type: textarea
    id: logs
    attributes:
      label: Relevant log output
      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
      render: shell
  - type: checkboxes
    id: terms
    attributes:
      label: Code of Conduct
      description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
      options:
        - label: I agree to follow this project's Code of Conduct
          required: true

Markdown 段落​

您可以在 YAML 模板中使用 markdown 元素為开发者提供额外的上下文支撑，这部分内容会作為建立工單的提示但不会作為工單内容提交。

attributes 子项提供了以下扩展能力：

键描述必選類型默认值有效值
value渲染的文本。支持 Markdown 格式必選字符串--

Textarea 多行文本输入框​

您可以使用 textarea 元素在表單中添加多行文本输入框。 除了输入文本，开发者還可以在 textarea 区域附加文件。

attributes 子项提供了以下扩展能力：

键描述必選類型默认值有效值
label预期使用者输入的简短描述，也以表單形式显示。必選字符串--
description提供上下文或指导的文本区域的描述，以表單形式显示。可選字符串空字符串-
placeholder半透明的占位符，在文本区域空白时呈現可選字符串空字符串-
value在文本区域中预填充的文本。可選字符串--
render如果提供了值，提交的文本将格式化為代码块。 提供此键时，文本区域将不会扩展到文件附件或 Markdown 编辑。可選字符串-Gitea 支持的语言。

validations 子项提供以下文本校验參數：

键描述必選類型默认值有效值
required防止在元素完成之前提交表單。可選布尔型false-

Input 單行输入框​

您可以使用 input 元素添加單行文本字段到表單。

attributes 子项提供了以下扩展能力：

键描述必選類型默认值有效值
label预期使用者输入的简短描述，也以表單形式显示。必選字符串--
description提供上下文或指导的字段的描述，以表單形式显示。可選字符串空字符串-
placeholder半透明的占位符，在字段空白时呈現。可選字符串空字符串-
value字段中预填的文本。可選字符串--

validations 子项提供以下文本校验參數：

键描述必選類型默认值有效值
required防止在未填内容时提交表單。可選布尔型false-
is_number防止在未填数字时提交表單。可選布尔型false-
regex直到满足了与正则表达式匹配的值。可選字符串-正则表达式

您可以使用 dropdown 元素在表單中添加下拉菜單。

attributes 子项提供了以下扩展能力：

键描述必選類型默认值有效值
label预期使用者输入的简短描述，以表單形式显示。必選字符串--
description提供上下文或指导的下拉列表的描述，以表單形式显示。可選字符串空字符串-
multiple确定使用者是否可以選择多个選项。可選布尔型false-
options使用者可以選择的選项列表。 不能為空，所有選择必須是不同的。必選字符串数组--

validations 子项提供以下文本校验參數：

键描述必選類型默认值有效值
required防止在元素完成之前提交表單。可選布尔型false-

Checkboxes 复選框​

您可以使用 checkboxes 元素添加一组复選框到表單。

attributes 子项提供了以下扩展能力：

键描述必選類型默认值有效值
label预期使用者输入的简短描述，以表單形式显示。必選字符串--
description复選框集的描述，以表單形式显示。 支持 Markdown 格式。可選字符串空字符串-
options使用者可以選择的复選框列表。 有关语法，請参阅下文。必選数组--

對於 options，您可以设置以下參數：

键描述必選類型默认值有效值
label選项的标识符，显示在表單中。 支持 Markdown 用于粗體或斜體文本格式化和超文本链接。必選字符串--
required防止在元素完成之前提交表單。可選布尔型false-