加入我们,从10月8日至10日在纽约市,了解关于 GraphQL 分联和 API 平台工程的最新技巧、趋势和新闻。加入我们,参加2024年在纽约市的 GraphQL 大会
文档
免费开始

提议架构变更

在GraphOS中编辑规范,检查更改并请求审查


此功能仅适用于GraphOS企业计划 您可以通过免费注册企业试用版来测试它.
企业试用 本文描述了在提案创建阶段的规范提案工作流程中的操作。.

开始一个提案

Proposal creation
Start proposal
Draft status
Edit subgraphs, lint,
save, and check changes
Request reviews

您可以在

GraphOS工作室中创建一个新提案。要访问该页面,请:

  • 从左侧导航菜单中选择特定的“提案”页面。

    Opening the Proposals page from the left navigation in GraphOS Studio

    注意

    如果您在特定的左侧导航中看不到“提案”,则可能是因为该图是一个规范提案是为使用设计的,并且不适合用于单图表。请使用将单图表转换为子图。

  • 在“图”页面,点击带提示信息“转到该图的规范更改提案”的铅笔图标。

    The Graphs page in GraphOS Studio

按照以下步骤创建新提案:

  1. 单击右上角的提出更改按钮。将出现一个名为提出规范更改的对话框。

  2. 输入描述性的提案标题,概述您计划提出的规范更改。

    注意

    如果以后想编辑提案的标题,您可以从其概览选项卡中进行编辑。

  3. 如果您是从 图形 而不是特定 开始的提案,请选择一个 源变体. 该 的模式用于启动提案,但提案不会与在提案进行过程中发生的任何模式更改同步。

    💡 提示

    Apollo推荐从开发变体创建模式提案

    从开发 变体 提出模式更改可以最小化直接更改生产模式相关的风险。它允许最早发现问题和潜在的改进。

    注意

    您不能为 创建提议,因为这些是根据其 源变体 自动生成的。

  4. 可选地,输入提议的更改理由。此理由作为您的提议的 描述 在提议概述中显示,并为参与者和管理员提供变更上下文。此输入接受Markdown。

    注意

    如果要稍后编辑提案的描述,您可以从其 概览 选项卡中进行编辑。

  5. 点击 创建提案

创建提案后,将跳转到专门为新创建的提案创建的 编辑 选项卡。此选项卡是您提出想要提出的方案更改的地方。

编辑子图模式

您可以直接从一个或多个提案的 编辑 选项卡中编辑

Schema proposals editor in GraphOS Studio

要创建新的 ,请从左侧导航中的 选择器中点击 +添加新。您还可以通过点击子图名称右侧的 ••• 菜单来删除现有子图并重命名新创建的子图。

清理更改

要清理您所做的模式更改,请点击编辑器右上角的扫帚图标。点击此按钮会打开一个面板,您可以在其中运行编辑器当前更改的 模式清理器。在成功运行您的模式清理之后,面板会显示任何清理违规,以便您可以相应地进行修复。

如果您在找到违规的确切位置时遇到困难,请点击违规列表中的行以在编辑器中突出显示它。

Highlighting linting violations in GraphOS Studio

注意

由于重命名或删除了一个 ,违规行号可能不再存在。发生这种情况时,违规在违规列表中显示为灰色。

一旦在编辑器中进行了更改,请通过点击模式清理面板右上角的重新运行按钮重新运行清理器。

保存修订版

更改完成后,请点击编辑器左下角的 保存修订版 按钮。将弹出一个对话框,您可以在其中可选地包含更改的总结。此输入接受Markdown。

修订摘要显示在您的提案概览标签下的活动页面。一个提案可以包含必要的任何修订次数。

💡 提示

您可以将每个修订看作是版本控制范式中的 提交。将每个修订视为原子性变更可以使审阅者了解构成提案的变更概述。

模式检查

模式检查在保存修订时自动运行。这些检查显示在提案的 检查标签页。

检查将提案更改与提案源变体最最新版本的方案进行对比。例如,如果您的提案移除了一个在源变体的最新发布版中已被移除的字段,则检查不会将此移除视为变更。这允许检查尽可能高效地检测提案中的破坏性变更。

自我审查和评论

在工作于提案且在向队友请求审阅之前,您可能想自己审阅提案。有关如何审查提案的不同方面和在提案上提供评论的说明,请参阅 审阅提案文章。

更改提案状态

您可以通过点击 编辑状态来从概览页面更改提案的状态。您有以下选项:

  • 草案:创建时的默认状态
  • 公开征求意见:表示提案已准备好审阅
  • 关闭:表示提案已被放弃或暂停
    • 关闭的提案无法再进行修订
    • 您始终可以通过将状态重置为 草案公开征求意见来重新打开提案。

批准实施的状态在满足 必要的条件后自动设置。

请求审阅

通过点击提案概览标签页上的 管理审阅者来添加审阅者。如果已配置 默认审阅者,则一旦提案的状态设置为 公开征求意见,这些审阅者将自动选择。

审批

一旦提案收到 所需的最低数量审批,其状态将更改为 批准

修改已批准的提案不会改变提案的已批准状态。要将提案的状态设置为开放反馈或其他状态,请手动从提案概览页进行更改

一旦提案获得批准,您的团队可以开始实施批准的更改。

注意

模式提案即使是批准的提案—也不将对您的图进行任何更改。一旦提案获得批准,您的团队必须实施并发布更改

上一页
配置提案
下一页
审查提案
评价文章评价在GitHub上编辑编辑论坛Discord

©2024Apollo Graph Inc.,即Apollo GraphQL。

隐私政策

公司