Azure DevOps 服务 |Azure DevOps Server |Azure DevOps Server 2022
保留策略控制在 Azure DevOps 中管道运行、经典版本和测试数据的保留时间。 这些设置通过定义何时应删除旧数据以及保留更长时间的数据来帮助你平衡存储使用情况、合规性和可跟踪性。 本文介绍可用的保留选项,以及它们如何应用于管道、发布和测试。
先决条件
| Product | 要求 |
|---|---|
| Azure DevOps | - Azure DevOps组织。 - Azure DevOps项目。 |
| 权限 | - 默认情况下,如果你是“参与者”、“生成管理员”、“Project管理员”或“发布管理员”组中的成员,则可以管理保留策略。 - 若要管理保留策略,需要以下订阅之一: Enterprise、 Test Professional 或 MSDN 平台。 - 还可以购买每月Azure Test Plans访问权限,并分配 Basic + 测试计划访问级别。 有关详细信息,请参阅 “按用户角色测试访问权限”。 |
重要
Azure Pipelines不再支持每管道保留策略。 建议使用项目级保留规则。
配置保留策略
若要打开项目中的保留设置页,然后选择要管理的策略区域,请执行以下步骤:
登录到Azure DevOps项目。
选择
>Project 设置。选择以下选项之一:
- 在“管道”下,选择“设置”来配置运行、项目、符号、附件和拉取请求运行的保留期。
- 在 “管道”下,选择“ 发布保留 ”以配置发布保留设置,包括何时删除或永久销毁发布。
- 在“ 测试”下,选择“ 保留 期”以配置手动和自动测试运行的时间。
管线执行保留策略
在大多数情况下,无需无限期地保留已完成的运行。 通过运行保留策略,您可以定义在删除之前保留运行记录和相关数据的期限。
警告
Azure DevOps 不再支持每个管道的保留规则。 为 YAML 和经典管道配置保留策略的唯一方法是通过前面所述的项目设置。 不能再配置每个管道的保留策略。
根据存储库类型,对 每个管道保留最近运行次数的设置 会有不同的解释:
Azure Repos:Azure Pipelines 保留为 pipeline 的默认分支和存储库中每个受保护分支配置的最新运行次数。 受保护的分支是配置分支策略的任何分支。
例如,请考虑具有两个分支的存储库:
main和release。 如果管道默认分支具有mainrelease分支策略,则release被视为受保护的分支。 如果将保留期配置为保留三次运行,则 Azure Pipelines 会为main保留最新的三次运行,为release保留最新的三次运行,并为整个管道(不考虑分支)保留最新的三次运行。以下示例假设最新的运行列在最前面。 它显示了当您配置保留策略以保留最新的三个运行时(忽略基于天数的设置),哪些运行会被保留。
运行编号 分支 保留/未保留 为什么? 运行 10 主要 保留 main 的最新 3 个和 pipeline 的最新 3 个 运行 9 branch1 保留 最近 3 个用于管道 运行 8 branch2 保留 最近 3 个用于管道 运行 7 主要 保留 最近 3 个用于主要 运行 6 主要 保留 最近 3 个用于主要 运行 5 主要 不保留 不是 main 或管道的最新 3 次运行 运行 4 主要 不保留 不是 main 或管道的最新 3 次运行 运行 3 branch1 不保留 不是 main 或管道的最新 3 次运行 运行 2 发布 保留 最新的 3 个版本用于发布 运行 1 主要 不保留 不是 main 或管道的最新 3 次运行 要保留的天数是从运行完成的日期开始计算的。 例如,1 月 19 日在 main 分支上有两次运行。 完成较晚的运行会被保留。
所有其他 Git 存储库:Azure Pipelines 为整个管道保留配置的最新运行次数。
Team Foundation 版本控制 (TFVC):Azure Pipelines 为整个管道保留配置的最新运行次数,与分支无关。
注意
保留策略仅保留成功和部分成功的运行记录。
执行过程中哪些部分被删除
删除一次运行时,会移除以下数据:
- 日志
- 所有管道和构建工件
- 所有符号
- 二进制文件
- 测试结果
- 运行元数据
- 源标签 (TFVC) 或标记 (Git)
管道运行保留不管理通用包、NuGet、npm 和其他包。
何时删除运行
如果满足以下所有条件,则会删除运行:
- 它超过了在保留设置中配置的天数。
- 它不是保留设置中配置的最新运行之一。
- 它未标记为永久保留。
- 它没有被发布保留。
保留策略每天处理一次。 处理时间各不相同,因为工作在一天中分布,以便进行负载均衡。 无法更改此计划。
自动为管道运行设定保留租约
保留租约允许你扩展或控制管道运行的生命周期,使其超出已配置的保留期限。 可以使用 租约 API 添加或删除管道运行的租约。 可以在管道内使用脚本以及用于 和 runId 的definitionId来调用此 API。
可以设置特定持续时间的租约。 例如,你可以保留部署到测试环境的运行较短的时间。 你可以保留部署到生产的运行较长的时间。
在管道运行上手动设置保留租约
可以在管道运行详情页面上的“更多操作”菜单中手动保留管道运行。
发布保留策略
经典发布管道的发布保留策略决定了发布及其关联运行的保留时长。 使用这些策略,可以配置这两种策略:
- 每个发布在上次修改或部署之后将被保留的天数。
- 每个管道要保留的发布最少数量。
每次发布被修改或部署到阶段时,保留计时器都会重置。 最低发布设置优先于基于天数的设置。 例如,如果将最小值设置为三个版本,则不管配置的天数如何,都会保留三个最新版本。 如果不再需要这些版本,仍可手动删除这些版本。 有关详细信息,请参阅本文后面的常见问题解答。
YAML 和生成管道使用相同的运行保留策略。 可以在 Project settings>Pipelines>Settings 下查看这些设置。
全局发布保留策略
在Azure DevOps服务中,可以查看这些设置,但无法在项目级别更改这些设置。
可以在项目设置的 发布保留 页面中查看 项目设置中的全局发布保留设置。
- 最大保留策略:定义可以在所有发布管道中保留发布的时间上限。 管道作者无法配置超出此限制的保留期。
- 默认保留策略:定义应用于发布管道的默认保留值。 管道作者可以覆盖这些默认值。
- 永久销毁版本:控制在永久删除之前保留已删除版本的时间。 单个发布管道不能覆盖此策略。
全局发布保留策略
如果您使用内部部署的 Azure DevOps Server,您可以配置项目级别的默认值和最大值以管理版本保留。 您还可以设置已删除版本永久销毁的时间。 (它们已从“生成资源管理器”中的 “已删除 ”选项卡中删除。
- 最大保留策略:定义可以在所有发布管道中保留发布的时间上限。 管道作者无法配置超出此限制的保留期。
- 默认保留策略:定义应用于发布管道的默认保留值。 管道作者可以覆盖这些默认值。
- 永久销毁版本:控制在永久删除之前保留已删除版本的时间。 单个发布管道不能覆盖此策略。
设置集合级别保留策略
如果使用本地服务器,还可以使用自定义规则配置集合级保留。 这些设置适用于经典生成管道,并定义集合的默认和最大保留值。
使用“复制文件”任务可以更长时间地保存数据
如果需要将生成输出保留时间长于配置的保留期,请使用 “复制文件”任务将其复制到自己的存储位置。
使用 复制文件 而不是 发布生成项目,因为作为生成项目发布的数据仍受保留清理的影响。
FAQ
如果将运行或发布标记为无限期保留,保留策略是否仍适用?
不是。 当将管道的某次运行或发布标记为无限期保留时,管理员设置的管道保留策略和最大限制都不会被应用。 它保持不变,直到你无限期地停止保留它。
如何指定部署到生产环境的运行应保留更长时间?
如果使用经典版本部署到生产环境,请在发布管道上自定义保留期。 设置保留部署到生产环境中的发布版本的天数,并指定保留与这些发布版本关联的运行任务。 此设置会替代运行保留策略。
如果使用多阶段 YAML 管道,则只能在项目设置中配置保留期。 你不能通过部署环境配置保留。
我没有将运行标记为无限期保留,但许多运行正在被保留。 我如何才能防止此行为?
此行为可能是由于以下原因之一导致的:
- 项目中有人将运行标记为无限期保留。
- 发布会使用这些运行,并且发布对这些运行持有保留锁。 如前所述自定义发布保留策略。
如果不再需要这些运行,或者如果保留它们的发布已被删除,你可以手动删除这些运行。
“要保留的最小发布数”设置是如何工作的?
“要保留的最小发布数”值是在阶段级别定义的。 Azure DevOps始终会保留阶段中最近部署的版本数量,即使这些版本已经超过保留期限。 只有当部署开始进入该阶段时,发布才会被算入此最小值。 成功和失败的部署均进行计数。 未计入待审批的发布。
当发布部署到具有不同保留期的多个阶段时,如何决定保留期?
最终保留期由发布部署到的所有阶段的“要保留的天数”设置决定,使用这些阶段中的最大值。 要保留的最小版本 与特定阶段相关,且不会因发布部署到一个或多个阶段而更改。 “保留关联的项目”选项只有在发布所发布到的阶段启用了该选项的情况下才会应用。
我删除了一个阶段,其中有一些旧发布。 在这种情况下,将考虑保留哪些保留期?
删除阶段后,其阶段级保留设置将不再应用。 在这种情况下,Azure DevOps使用项目级默认保留设置。
我的组织需要我们将生成和发布保留比设置中允许的时间更长的时间。 如何请求更长的保留期?
若要保留比配置的保留限制更长的运行或发布,请将其标记为无限期保留。 没有设置手动配置更长的保留期。 如需帮助,请联系 Azure DevOps 支持人员。
还可以使用 REST API 下载运行信息和项目,然后将其存储在自己的存储帐户或项目存储库中。
我丢失了一些运行。 是否有办法将其找回?
如果你认为运行因服务 Bug 而丢失,请立即创建支持票证。 如果一周前手动删除了生成定义,则无法恢复它。 如果根据保留策略按预期删除了运行记录,那么无法恢复这些记录。
如何使用代理的 Build.Cleanup 功能?
在代理上设置 Build.Cleanup 功能只会将清理作业路由到这些代理,这让其他代理可用于常规管道工作。 当管道运行被删除时,存储在 Azure DevOps 之外的项目将通过代理作业进行清理。 如果清理作业使池饱和,请将一部分代理指定作为清理代理。 当Build.Cleanup被设置在任何代理上时,只有这些代理会运行清理作业。 若要启用此设置,请转到 代理>功能 并设置为 Build.Cleanup1。
生成被删除时,文件共享项目会发生什么情况?
当具有文件共享项目的生成被删除时,会在生成代理上排队一个新的生成任务来清理这些文件。 根据以下条件选择代理以执行此任务:
- 是否有具有
Build.Cleanup功能的代理可用? - 运行生成的代理是否可用?
- 同一池中的代理是否可用?
- 类似池中的代理是否可用?
- 是否有任何代理可用?
发布过程中发布的自动测试结果是否一直保留到发布被删除为止?
在发布阶段中发布的测试结果将根据测试保留策略(而非发布保留策略)进行保留。 如果需要在发布期间保留测试结果,请在 Project 设置中将自动测试运行保留设置为 从不删除。 此设置可确保仅在删除发布时删除测试结果。
是否会删除手动测试结果?
不是。 不会删除手动测试结果。
如何保留版本控制标签或标记?
如果在删除构建后必须保留标签或标记,请在管道任务中应用它们,或在管道之外手动添加,或无限期地保留构建。
重要
在生成管道期间应用的任何版本控制标签或标记(如果不是由 Sources 任务自动创建的)都会被保留,即使生成被删除。 在生成过程中由 源 任务自动创建的标签或标记被视为生成项目,并且随生成一起删除。
在其他管道中被消耗的管道会发生什么情况?
经典发布会保留它们自动使用的管道。
在其他管道中被消耗的管道会发生什么情况?
经典发布会保留它们自动使用的管道。 如果使用 YAML,还可以创建一个多阶段 YAML 管道来表示发布并使用其中的另一个 YAML 管道作为 资源。 只要发布管道被保留,资源管道就会自动被保留。