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

模式建议

提出、审核和跟踪新发布的模式更改


此功能仅适用于 GraphOS 企业版计划.
您可以通过注册免费 企业试用版.

随着您的 增长,管理更改变得更加困难。评估 更改对 组合 和客户端 变得更加复杂。一旦就方案设计变更达成一致,在 开发过程中实施这些变更又是一个挑战。

当同时更新多个 并跨团队合作时,这些挑战会加剧。在没有明确跨团队沟通以理解、验证和跟踪更改的情况下,可能会阻碍方案开发。

架构变更管理方案提案

为集中式架构变更管理提供支持。集中化提案流程促进协作并加强架构治理:

  • 开发者可以在 的上下文中提出变更,使用自动化检查和审查员反馈进行验证。
  • 消费者可以通过发表评论、审查和批准提案来积极参与。
  • 拥有者和治理团队可以使用提案来制定标准并确保仅发布已批准的变更。

这种增加的协调提高了设计决策的问责制,简化了开发周期。

原生架构变更管理的优势

中直接管理架构变更提供了以下优势:

  • 提案流程使用GraphOS架构检查—架构检查——包括架构代码检查——在每个步骤中都使用。
    • 这最大限度地减少了错误和不一致的可能性。
    • 它还提供了对变更对 和客户端操作影响的即时理解。
  • 在GraphOS中进行编辑、审查和批准变更允许进行GraphQL感知的架构差异比较。
    • 例如,GraphOS 提案编辑器将新和类型作为新的字段和类型比较,不受格式限制。
    • 相比之下,非GraphQL的文本差异比较可能无法理解差异,除非它们按传统格式设置。
  • 集中化架构变更流程可以巩固一个全面的审计跟踪,记录讨论和架构变更。

架构提案的工作方式

—然后才会将架构变更发布到GraphOS。

注意

架构提案—甚至已经 批准的的 — 不要将任何更改部署到您的。 一旦提案被批准,您的团队必须实施并发布这些更改

组织管理员和图管理员可以配置架构检查以确保组织只发布通过提案批准的更改。

在深入了解架构提案工作流程之前,了解提案状态会有所帮助。

提案状态

状态自动或
手动设置
描述
草稿
在提案创建时自动但可以
手动重置
创建默认状态,直到提案准备好审查。
公开征求反馈
手动表示提案已准备好审查。

- 如果配置了 默认审稿人,他们将被分配进行审查。
批准
自动表示 最低数量的审稿人 已批准提案。

- 如果您已 要求默认审稿人批准,则至少需要一个默认审稿人的批准。
实施
自动表示该提案的所有更改 已发布.

- 已实施的提案无法接收进一步修订。
- 它们的状态无法更新。
关闭
手动表示提案已暂停或废弃。

- 关闭的提案无法接收进一步修订。
- 您可以将提案的状态设置为 草稿公开征求意见 以重新开启提案。

提案不必从 草稿线性地进展到 实施。 例如,它可能在返回到 草稿之前被关闭,并继续通过该流程。

提案工作流程

架构提案状态使以下端到端架构更改管理工作流程成为可能:

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

Proposal review
Open for
feedback
status
Receive feedback
Address feedback
Receive
minimum approvals

Proposal implementation
Approved
status
Fetch proposal and
implement locally
Run checks on
local changes
GraphOS
schema checks

Proposal publication
Schema checks
pass
Publish schema
to GraphOS
GraphOS matches
changes to proposals
Implemented
status

说明

Proposal
status
User action
Automated
GraphOS action

下一步

架构提案的默认配置允许您直接开始使用提案。 如果您想要调整您的提案流程,请查看配置提案。 配置包括权限、批准要求、电子邮件通知等。

有关流程每个阶段的更多详细信息,请参阅以下文章

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

©2024Apollo Graph Inc.,以Apollo GraphQL名义。

隐私政策

公司