Skip to main content

Enterprise Server 3.23 目前作为发布候选版本提供。

Skip to content

添加和管理问题字段

可以针对各个问题设置、编辑和清除问题字段值,以捕获团队的结构化元数据。

谁可以使用此功能?

People with triage access or greater to a repository can set and edit issue field values.

问题字段显示在问题的右侧边栏中,随之显示的还有系统字段,如代理人、标签和类型。 可以在创建或编辑问题时设置值。 在创建问题时选择问题类型时,与该类型关联的字段将自动显示在侧边栏中。

注意

问题字段当前仅在问题上可用。 拉取请求不支持议题字段。

设置字段值

  1. 导航到您要更新的问题。
  2. 在右侧栏中,如果所需的字段尚未显示,请单击“ 添加”字段。
  3. 从下拉列表中,选择要添加的字段。
  4. 设置值:
    • 对于 单选 字段,请从下拉列表中选择一个选项。
    • 对于 文本 字段,请键入值。 URL 会自动检测并显示为链接。
    • 对于 数字 字段,请输入数值。
    • 对于 日期 字段,请使用日期选取器选择日期,或直接键入日期。
  5. 更改会自动保存。

注意

问题字段当前无法通过 URL 查询参数预先填充,也不能通过问题模板进行设置。 若要设置字段值,请使用问题边栏、项目、API 或 GitHub Actions。

编辑字段值

  1. 导航到问题。
  2. 在右侧栏中,单击要更改的字段值。
  3. 选择新值或键入新条目。
  4. 更改会自动保存。

清除字段值

  1. 导航到问题。
  2. 在右侧栏中,单击该字段的值。
  3. 清除值:
    • 对于 单选 字段,请单击当前选择的选项以取消选中它。
    • 对于 文本 和 数字 字段,请删除输入中的所有文本。
    • 对于 日期 字段,请单击日期选取器中的清除按钮。
  4. 清除后,字段将从边栏中删除。 可以使用 “添加字段 ”按钮重新添加它。

固定的字段

如果字段已由组织管理员固定到特定的问题类型上,或由你为自己拥有的仓库固定到特定的问题类型上,则在你创建或查看该类型的问题时,这些字段会自动显示在侧边栏和问题创建模态窗口中。 无需手动添加固定字段。

在时间线上查看字段更改

更改字段值后,更新将记录在问题时间线中。 时间线条目显示:

  • 更改了哪个字段
  • 已设置的新值
  • 做出更改的人员
  • 进行更改的时间

设置为“受限”可见性的字段的时间线事件,在组织拥有的存储库中仅对组织成员和存储库协作者可见,或者在用户拥有的存储库中仅对存储库所有者和协作者可见。

字段可见性

组织管理员和用户帐户所有者可以将每个字段的可见性设置为“受限”或“公共”。 这会影响你看到的内容:

  • 如果字段设置为 “受限”,则只有具有组织拥有存储库中至少读取访问权限的组织成员和存储库协作者或至少具有用户拥有存储库中读取访问权限的存储库所有者和协作者才可见。 如果你无权访问该字段,则它不会出现在问题边栏、时间线或搜索建议中。
  • 如果字段设置为 “公共”,则任何查看问题的人都可以看到该字段。

有关配置可见性的详细信息,请参阅 管理问题字段。

在项目中使用问题字段

可以将问题字段添加为项目视图中的列,可在其中编辑值、分组、筛选、排序和生成图表。 有关详细信息,请参阅“关于项目中的问题字段”。

按字段值搜索

可以根据问题仪表板和存储库问题页中的字段值筛选和搜索问题。 在搜索栏中,键入 field. 后跟字段名称和值。 例如:

  • field.priority:high 查找优先级为“高”的问题
  • field."target date":>=2026-03-01 查找目标日期为 2026 年 3 月 1 日或之后的问题
  • field.priority:high,medium 查找优先级设置为“高”或“中”的问题

有关详细信息,请参阅“筛选和搜索议题以及拉取请求”。

在 API 中使用问题字段

问题字段具有完整的 REST 和 GraphQL API 支持。 你可以自动执行字段管理、以编程方式设置值并与外部工具集成。

  • 管理字段:创建、更新和删除字段。 请参阅 问题字段 REST API。
  • 使用字段:获取、设置和清除单个问题的字段值。 请参阅“问题”字段值 REST API。
  • GraphQL:问题字段类型和突变也可通过 GraphQL 获得。 请参阅IssueFields 联合、问题字段对象(如 IssueFieldText、IssueFieldSingleSelect、IssueFieldNumber 和 IssueFieldDate)和突变(如 createIssueField、updateIssueField 和 setIssueFieldValue)。

使用 GitHub Actions 实现自动化

问题字段更改会在 issues 事件时触发 Webhook 事件。 可以使用这些触发器作为工作流触发器:

  • field_added:设置或更新字段值时触发。
  • field_removed:字段值被清空时触发。

例如,每当字段值更改时运行工作流:

on:
  issues:
    types: [field_added, field_removed]

事件有效负载包括字段名称、类型、值和上一个值。 有关详细信息,请参阅“触发工作流的事件”。