项目历史记录

概览

Altium 365 工作区的项目历史记录将项目开发过程中的关键里程碑汇集到一条时间线上,包括创建、提交、发布、克隆以及 MCAD 数据交换。本文介绍如何通过浏览器界面访问和浏览这些历史记录,并深入讲解提交详情、设计快照和标签。此外,本文还将说明为何必须使用工作区原生的 Git 版本控制才能获得完整功能。继续阅读,了解如何更轻松地查看项目的历史记录。

- 了解在哪里找到“历史记录”视图,以及时间线如何组织项目事件。
- 了解查看提交历史记录所需满足的版本控制要求。
- 探索如何检查提交中的更改、打开历史设计快照,以及添加提交标签。
使用 AI 深入了解:
 

无法轻松查看项目开发历程的历史记录,常常令设计人员和产品经理感到困扰。设计人员往往不得不熟悉外部 VCS 管理工具,而熟练使用这些工具通常需要相当程度的专业知识——如果只是想执行基本的项目管理任务,这无疑会耗费大量时间。即使您精通外部 VCS 工具,它们也只能处理项目的某些方面,例如打开、克隆和回退等与 VCS 相关的操作。那么,版本发布和 MCAD 交换等更广泛的项目管理工作又该如何处理呢?此外,别忘了,这些操作中的大多数通常还需要在桌面端完成。

为了满足在同一位置查看此类信息并与之交互的需求,Altium 365 工作区提供了一种简洁高效的解决方案,引入了 Project History 的概念。通过工作区的浏览器界面(上层 Altium 365 平台界面的组成部分)或 Altium Designer,您可以访问专用的 History 视图。该视图按时间顺序展示与项目相关的重大事件,包括创建、提交、发布、克隆和 MCAD 交换,并在适用时支持各种操作,例如查看设计源文件的快照。

要充分利用此功能,您需要将项目添加到工作区内置的 VCS(Git)中,使其成为完全托管的项目。在工作区的浏览器界面中,新项目始终创建在此原生 VCS 下。在 Altium Designer 中,您可以在创建新项目或使现有本地项目在线可用时,使用 Version Control 选项来完成此操作(前提是该项目尚未纳入外部版本控制)。这样,您就可以充分使用工作区和 Altium 365 平台提供的各项功能。

如果您的项目已纳入外部版本控制,可以将其迁移为工作区中的完全托管项目,将设计文件存储在服务器自身的 Git 仓库中(实际上就是切换到工作区的原生 VCS)。Altium Designer 的“使其在线可用”对话框提供了 Migrate to <server> Versioned Storage 选项,可启动 VCS 迁移流程,而不是仅在工作区中镜像项目结构。如果外部 VCS 项目已作为镜像项目(简单同步)在工作区中管理,则可以使用 Migrate to Versioned Storage 命令,将其 VCS 文件迁移到工作区的原生 Git 仓库。该命令可从“项目历史记录”视图、“项目选项”对话框的“常规”选项卡,以及“项目”面板的“版本控制”右键菜单中访问。有关具体操作的详细信息,请参阅从外部 VCS 迁移到工作区原生 VCS。

本文介绍如何通过 Web 界面使用项目的 History 视图。有关在 Altium Designer(20.2 或更高版本)中使用此视图的信息,请参阅在 Altium Designer 中查看项目历史记录。在 Altium Designer 中,该视图显示为独立的选项卡式文档(<ProjectName>.PrjPcb History)。

访问项目历史记录

您可以从项目的详细管理页面访问该项目的 History 视图。单击左侧窗格中的 History 条目。

要打开详细管理页面,请在界面的 Projects 页面中选择所需项目,单击项目列表上方的 控件,然后在相应菜单中选择 Open 条目。您也可以直接双击列表中所需的项目条目。该页面将在新的浏览器选项卡中打开。有关更多信息,请参阅管理特定项目。

从项目的详细管理页面访问该项目的历史记录。从项目的详细管理页面访问该项目的历史记录。

对于在“项目历史记录”功能推出之前就已存在于工作区中的项目,其历史记录最初并不完整。首次访问该项目的 History 视图时,系统会自动重新索引该项目的事件数据。重新索引完成后,视图底部会显示通知——单击 控件,即可使用完整的历史事件数据更新时间线。

历史时间线——概述

History 视图以时间线的形式展示项目演进过程中发生的基本事件。该视图主要分为三个关键部分,如下图所示,后文将详细介绍。

History 视图的三个关键组成部分。History 视图的三个关键组成部分。

  1. Main trunk of the timeline。事件按时间从下往上排列。第一个事件(即项目创建)显示在时间线底部。后续事件依次显示在上方,最新事件显示在时间线顶部。
  2. Events。每当项目发生受支持的事件(见下文)时,该事件就会作为独立卡片添加到时间线中。不同类型的事件具有不同颜色的卡片,并且会直接连接到时间线主干,或在旁边显示附加图标(例如 MCAD 交换事件)。
  3. Search。单击视图右上角的 控件,可打开搜索字段,对项目历史记录执行基本搜索。输入搜索字符串时,系统会筛选时间线,仅显示与搜索内容相关的事件。有关更多信息,请参阅筛选搜索。

支持的事件

时间线展示项目生命周期中发生的一系列事件。每个事件都以独立的“事件卡片”显示在时间线上。以下各节介绍目前支持并可在项目历史时间线中呈现的各类事件。

项目创建

Related pages: 创建新的托管项目(浏览器界面 / Altium Designer)、使现有项目在线可用、克隆项目(浏览器界面 / Altium Designer)

创建项目时,Project Created 事件卡片将添加到时间线中。此事件标志着项目历史时间线的起点,因此始终位于时间线底部。此事件的卡片有两种不同的显示形式:

  • 在工作区中新建项目时,卡片会显示项目创建者的姓名(及照片),以及项目创建的日期和时间。如果创建时输入了项目描述,卡片中也会显示该描述。

  • 当项目是从现有项目克隆而来时,将显示克隆项目创建者的姓名(及头像),以及项目创建的日期和时间。如果在克隆时输入了项目描述,该描述也会显示在事件卡片中。卡片中还提供了原始项目的链接,单击该链接可在浏览器的单独选项卡中打开该项目的详细管理页面。

Project Created 事件卡片通过蓝色实线和节点连接到时间线的主干:。

项目提交

此类事件仅适用于完全受管并存储在工作区原生 VCS 中(位于其 Versioned Storage Git 存储库内)的项目。对于已在工作区中可用、但未纳入正式版本控制的非受管项目(即采用简单同步方式的项目),历史时间线上不会显示任何与 VCS 相关的提交事件。要获取此信息,您可以在 Project Options 对话框的 常规选项卡中启用 Version Control 选项,以切换项目的在线可用方式。这会将项目纳入工作区原生 VCS 的管理。

对于已在工作区中可用、但已纳入外部版本控制的项目,历史时间线上同样不会显示任何与 VCS 相关的提交事件。请使用外部版本控制客户端查看项目的版本控制历史记录。或者,您也可以切换到工作区原生 VCS。Altium Designer 的使其在线可用对话框提供了 Migrate to <server> Versioned Storage 选项,可启用 VCS 迁移流程,而不只是在工作区中镜像项目结构。如果外部 VCS 项目已作为镜像项目(简单同步)在工作区中进行管理,则可以使用 项目历史记录视图、项目选项对话框的常规选项卡以及项目面板的“版本控制”右键菜单中提供的 Migrate to Versioned Storage 命令,将其 VCS 文件迁移到工作区原生 Git 存储库。有关具体操作的详细信息,请参阅从外部 VCS 迁移到工作区原生 VCS。

每次对项目执行 Commit & Push 至工作区时(项目由工作区内部的 Versioned Storage Git 存储库管理),时间线上都会添加一个 Project Committed 事件卡片。卡片会显示执行提交和推送的人员姓名(及头像),以及日期和时间。如果在提交和推送时通过提交到版本控制对话框添加了注释,该注释也会显示在卡片中。

如果项目最初是本地非受管项目,之后才使其在线可用,那么在使其在线可用对话框中输入的描述将同时用于 Project Created 事件卡片和初始 Project Committed 事件卡片,因为项目的提交和推送是使项目在线可用这一过程的一部分——当然,前提是已启用 Version Control 选项。

初始 Project Committed 事件卡片示例。初始 Project Committed 事件卡片示例。

卡片还支持并显示设计差异信息,更详细地展示当前提交与上一次提交之间的变化。支持的元素包括文件、元件、网络、变体和 PCB 结构。卡片的差异部分会汇总受此次提交事件影响的各类元素,并按以下状态分组:

– 添加的元素。

– 移除的元素。

– 修改的元素。

单击卡片中的 控件可展开差异部分,按名称显示受影响的元素。

使用提供的 Show More 和 Show Less 控件可查看各类元素的完整列表。单击卡片中的 控件可返回摘要显示。

单击卡片右上角的 控件,可打开包含以下命令的菜单:

  • View – 使用此命令可在 Web 查看器中打开所选提交的源设计数据,以查看该时间点的设计快照。
  • Create Tag – 为当前选定的提交添加 VCS 标签名称。提交所附的标签会显示在其历史记录视图卡片、Web 查看器中快照视图的标题栏,以及附加到该快照视图的任何评论中。为提交添加标签后,卡片的菜单命令将变为 Tag,并提供用于修改(Edit)或删除(Remove)提交标签的子选项。

选择“创建标签”菜单选项,为提交历史事件添加标签名称。选择“创建标签”菜单选项,为提交历史事件添加标签名称。

  • VCS 标签中不能使用某些字符。如果您尝试创建包含非法字符的标签,系统会通过提示信息提醒您。

  • 每个提交事件只能应用一个标签,不支持多个标签。

带标签的历史提交事件,其快照视图会标注标签名称。带标签的历史提交事件,其快照视图会标注标签名称。

在当前进行中的设计中查看评论时,在带标签提交的设计快照中创建的评论会包含关联的标签名称。选择标签名称链接可打开相关提交的快照。有关使用评论的更多信息,请参阅 Web 查看器评论。

添加到带标签提交事件快照中的评论会包含关联的标签名称。添加到带标签提交事件快照中的评论会包含关联的标签名称。

由 Altium Designer 的项目发布器创建的项目发布所关联的提交事件,会自动以发布修订版 ID作为标签。如有需要,之后可以编辑或删除生成的修订版提交标签。有关相关信息,请参阅发布到工作区。

Altium Designer 会自动使用发布 ID 为发布所关联的提交添加标签。Altium Designer 会自动使用发布 ID 为发布所关联的提交添加标签。

  • Schematic to – 允许您将此次提交中的原理图数据与另一次提交或发布事件中的原理图数据进行比较。使用子菜单可与上一次提交的源数据进行比较,也可以从所有可选的提交或发布中进行选择。选定用于比较的发布或提交后,比较结果将显示在比较视图中,该视图会在默认 Web 浏览器的新选项卡中打开。有关更多信息,请参阅原理图比较。
  • PCB to – 允许您将此次提交中的 PCB 数据与另一次提交或发布事件中的 PCB 数据进行比较。使用子菜单可与上一次提交的源数据进行比较,也可以从所有可选的提交或发布中进行选择。选定用于比较的发布或提交后,比较结果将显示在比较视图中,该视图会在默认 Web 浏览器的新选项卡中打开。有关更多信息,请参阅 PCB 比较。
  • BOM to – 允许您将此次提交中的 BOM 数据与另一次提交或发布事件中的 BOM 数据进行比较。使用关联的子菜单可与上一次提交的 BOM 数据进行比较,也可以从该项目的所有提交/发布中进行选择。选定比较目标后,比较结果将以颜色编码的 BOM 条目列表显示,表示指定提交/发布事件之间发生变化的条目。系统会以标准 CSV 格式生成汇总的变更摘要,并打包为 ZIP 压缩文件供下载。有关更多信息,请参阅 BOM 比较。
  • Clone – 使用此命令可基于项目的该特定修订版创建克隆。随后会显示 Clone Project 窗口,供您确定项目的 Name、Description 以及(工作区内的)Parent Folder。请注意,窗口的横幅文本会显示正在基于项目的哪个修订版创建克隆。按需填写信息后,单击 按钮。系统将创建项目,并在时间轴中添加一个 Project Cloned 事件卡片。
默认情况下,Parent Folder 将设置为与原始项目相同。单击该字段右侧的 Change 链接可访问工作区的服务器文件夹结构,从中选择其他文件夹来存储克隆项目。您可以根据需要将项目组织到分层的子文件夹中。有关更多信息,请参阅 创建项目文件夹层次结构。

您可以直接从活动项目任意特定修订版对应的 Project Committed 事件卡片创建该修订版的克隆。您可以直接从活动项目任意特定修订版对应的 Project Committed 事件卡片创建该修订版的克隆。

  • Download Sources – 使用此命令可下载项目该特定修订版的源文件,文件以 Zip 压缩包形式提供。Zip 文件和 PCB 项目文件的名称将包含该修订版提交并推送到工作区的日期和时间(UTC 时间)。
Project Committed 事件卡片通过蓝色实线和节点连接到时间轴主干:。项目的最新修订版(即最后一次提交)以白色填充的节点加以区分:。

项目发布

Related page: 设计项目发布

每次使用 Altium Designer 的 项目发布器发布项目时,时间轴上都会添加一个 Project Released 事件卡片。卡片会显示发布者的姓名(和照片),以及发布的日期和时间。如果在通过 “确认发布”对话框将生成的数据发布到工作区时添加了发布说明,该说明也会显示在卡片中。发布中包含的各个数据集也会列出,并标明其生命周期状态。

Project Released 事件卡片示例。Project Released 事件卡片示例。

单击卡片右上角的 控件,可访问包含以下命令的菜单:

  • View – 打开专用制造门户(在单独的浏览器选项卡中),以便更仔细地检查已发布的数据。在此门户中,您可以查看和浏览已发布的文件数据、检查 BOM,以及查看设计本身的快照并添加评论;该设计即为已发布数据的来源。您还可以使用相关控件下载不同粒度的制造数据(从完整数据集到单个生成的输出文件)。您也可以将选定的发布作为 Manufacturing Package 直接发送给制造商。有关更多信息,请参阅 通过制造门户浏览发布包。

访问专用的 Manufacturing Portal 选项卡,以便更仔细地检查项目发布。访问专用的 Manufacturing Portal 选项卡,以便更仔细地检查项目发布。

  • Schematic to – 允许您将此次发布中的原理图数据与另一次发布或提交事件中的原理图数据进行比较。使用子菜单可与上一次发布的源数据进行比较,也可以从所有可用的发布和提交中进行选择。选定要比较的发布/提交后,比较结果将显示在“比较”视图中,该视图会在默认 Web 浏览器的新选项卡中打开。有关更多信息,请参阅 原理图比较。

比较设计项目两次发布之间的原理图数据。比较设计项目两次发布之间的原理图数据。

  • PCB to – 允许您将此次发布中的 PCB 数据与另一次发布或提交事件中的 PCB 数据进行比较。使用子菜单可与上一次发布的源数据进行比较,也可以从所有可用的发布和提交中进行选择。选定要比较的发布/提交后,比较结果将显示在“比较”视图中,该视图会在默认 Web 浏览器的新选项卡中打开。有关更多信息,请参阅 PCB 比较。

比较设计项目两次发布之间的 PCB 数据。比较设计项目两次发布之间的 PCB 数据。

  • Gerber to – 允许您将此次发布生成的 Gerber 数据与另一组 Gerber 数据进行比较。使用关联的子菜单可与上一次发布的制造数据进行比较、从该项目的所有发布中进行选择(时间轴将经过筛选,仅显示 Project Released 事件卡片),或者与选定的一组本地生成(并已上传)的文件进行比较。选定比较目标后,结果将显示在 Gerber Compare 视图中,该视图会在单独的浏览器选项卡中打开。有关更多信息,请参阅 Gerber 比较。

比较设计项目两次发布生成的 Gerber 数据。 比较设计项目两次发布生成的 Gerber 数据。

  • BOM to – 允许您将此次发布中的 BOM 数据与另一次提交或发布事件中的 BOM 数据进行比较。使用关联的子菜单可与上一次提交的 BOM 数据进行比较,也可以从该项目的所有提交/发布中进行选择。选定比较目标后,比较结果将以颜色编码的 BOM 条目列表显示,表示指定提交/发布事件之间发生变化的条目。系统会以标准 CSV 格式生成汇总的变更摘要,并打包为 ZIP 压缩文件供下载。有关更多信息,请参阅 BOM 比较。

下载设计项目两个事件之间所生成 BOM 数据的比较结果。 下载设计项目两个事件之间所生成 BOM 数据的比较结果。

  • Download Outputs – 允许您通过随后显示的窗口,选择要下载发布包中的哪些输出数据集。完成选择后,单击 按钮。系统将下载一个 Zip 压缩包,其中包含各个选定数据集的文件夹。
  • Download Sources – 允许您以 Zip 压缩包形式下载用于创建该发布包的设计版本的源数据。
由于项目发布是非常重要的事件,Project Released 事件卡片会更加醒目——它并非只是一个“连接”到时间轴的事件,而是作为“重大”事件横跨时间轴。

项目克隆

Related page: 克隆项目(浏览器界面 / Altium Designer)

每次克隆项目时,无论是通过工作区的浏览器界面,还是在 Altium Designer 中操作,时间线上都会添加一个 Project Cloned 事件卡片。卡片中会显示执行克隆操作的人员姓名(及照片),以及操作日期和时间。如果克隆时通过 Clone Project 窗口(基于浏览器)或克隆项目对话框(Altium Designer)添加了描述,该描述也会显示在卡片中。卡片还提供指向克隆项目的链接,单击该链接即可在浏览器的新标签页中打开该项目的详细管理页面。

Project Cloned 事件卡片示例。Project Cloned 事件卡片示例。

从工作区浏览器界面的 Projects 页面或 Altium Designer 中(右键单击 Projects 面板中的项目条目,或在浏览项目时单击 Explorer 面板右上角的 按钮)使用的主要 Clone 命令,均作用于项目的最新(或 Head)修订版。在 History 视图中,您可以克隆项目的特定修订版。为此,找到所需项目修订版对应的 Project Committed 事件卡片,然后单击卡片右上角的 控件。从随后显示的菜单中选择 Clone 命令。
Project Cloned 事件卡片通过绿色虚线和空心节点连接到时间线主干:。

MCAD 交互

Related page: 了解有关 ECAD-MCAD 协同设计的更多信息

在电子设计与机械设计领域之间开展协作时,工作区充当两者之间的桥梁,实现直接 ECAD-MCAD 协同设计。每当项目的 PCB 设计发生更改,并通过相应的 CoDesigner 面板将这些更改推送到工作区时,时间线上都会添加一个 MCAD Changes Suggested 事件卡片。卡片中会显示执行推送操作的人员姓名(及照片),以及操作日期和时间。如果推送时通过 MCAD CoDesigner 面板(Altium Designer)或 Altium CoDesigner 面板(在受支持的 MCAD 软件中)发布了消息,该消息也会显示在卡片中。

目前仅支持 Push 事件。

MCAD Changes Suggested 事件卡片示例。MCAD Changes Suggested 事件卡片示例。

当 MCAD 工程师在受支持的 MCAD 软件中对 PCB 进行更改并将这些更改推送到工作区时,相应的推送事件会自动显示在项目的历史时间线上。请注意,您可能需要刷新“历史”页面才能显示最新更改。

此示例显示了两个与 MCAD 相关的事件。时间线主干左侧是来自 ECAD 端的推送事件,右侧是来自 MCAD 端的推送事件。此示例显示了两个与 MCAD 相关的事件。时间线主干左侧是来自 ECAD 端的推送事件,右侧是来自 MCAD 端的推送事件。

MCAD Changes Suggested 事件卡片并不直接连接到时间线主干,而是使用指向主干的方向箭头符号表示:。

筛选搜索

单击视图右上角的 控件可打开搜索字段,以便快速查找时间线上您感兴趣的事件。搜索功能支持对项目历史进行基本搜索,并在您输入搜索字符串时动态筛选,使页面上仅显示与该搜索相关的事件。事件卡片中匹配的文本会高亮显示。

搜索功能不区分大小写。

项目历史搜索示例。在您输入搜索词(不区分大小写)时,时间线会动态筛选,并在各个相关事件卡片中高亮显示匹配项。项目历史搜索示例。在您输入搜索词(不区分大小写)时,时间线会动态筛选,并在各个相关事件卡片中高亮显示匹配项。

筛选结果上方会显示一个信息框,汇总当前显示的事件数量,并提供用于快速移除筛选条件/搜索字符串的控件。

搜索功能支持搜索以下信息:

  • 事件卡片标题。
  • 执行该事件的人员姓名。
  • 描述文本(相关事件发生时填写的评论、备注或描述中的文本)。
  • 差异比较数据文本——位于 Project Committed 事件卡片中。
  • 数据集名称——位于 Project Released 事件卡片中。
  • 项目名称——位于 Project Cloned 事件卡片和 Project Created 事件卡片(通过克隆创建时)中。
要清除当前筛选并返回完整时间线,请清空搜索字段:选中当前文本并按 Backspace 键,或单击字段最右侧的 控件。您也可以单击汇总所显示事件数量的信息框(位于视图顶部)中的 Clear Filter 控件。

更新以显示新事件

每当发生与项目相关且受支持的事件时,系统都会自动检测该事件,并将其提供给 History 视图。事件发生后不久,视图底部便会显示通知;单击 控件即可更新时间线,显示新事件。

您也可以单击视图右上角的 控件进行手动刷新。
AI-LocalizedAI 翻译
如您发现任何问题,请选中相关文本/图片,并按 Ctrl + Enter 键向我们提交反馈。
Contents
功能可用性

您可使用的功能取决于您所采用的 Altium 解决方案——Altium Develop、Altium Agile Teams、Altium Agile Enterprise,或 Altium Designer(在有效订阅期内)。

如果您在实际软件中未看到文档中介绍的某项功能, 请联系 Altium Sales 了解更多信息。

Contents