Using External Git Version Control with Altium Designer

Git类型的仓库是在Altium Designer之外创建的,通过打开其宿主文件夹中的文件来访问本地工作Git仓库的内容。远程和本地工作Git仓库的管理通常通过公司系统和外部Git工具来进行,而文件级操作(提交、推送、更新等)则在Altium Designer编辑环境中处理。
  • 在使用Git版本控制进行设计项目之前,请确保在Altium Designer中安装了VCS提供商 - Git扩展。这些默认情况下会安装,但可以在软件的扩展和更新视图中访问。
  • 请注意,Git仓库是在Altium Designer之外处理的。
  • 虽然 Git VCS 提供了多种数据传输协议,但 Altium Designer 目前仅支持HTTP/HTTPS协议,用于本地 Git 仓库与其远程主仓库之间的连接。了解更多关于协议的信息。
  • 当向使用外部 Git VCS 的项目推送更改时,如果该设计所在的仓库使用 SSH 协议进行连接,将提供选择尝试将该仓库更新为使用支持的 HTTPS 连接协议(前提是该仓库支持此协议)。
  • 请注意,当使用 Altium Designer 从托管在 GitHub 的项目工作时,必须使用个人访问令牌。否则,在将项目推送到仓库时会出现身份验证错误。了解更多关于创建个人访问令牌的信息。

添加到 Git 版本控制

作为一个分布式版本控制系统,Git 使用的工作流程与 SVN 不同,尽管在使用 Altium Designer 中的已建立项目文件时,这种差异是最小的。简而言之,Git 采用了在多个仓库之间传输数据的方式,而不是依赖单一仓库目标。

► 有关更多信息,请访问Git 网站,并查看版本控制基础以了解适用的原则。

Git 版本控制系统通常基于一个集中式的远程 Git 服务器,该服务器可以根据需要托管多个 Git 仓库。Git 的快速、轻量级特性使其非常适合为每个项目创建一个远程仓库的做法,然后任何参与项目的用户都可以将其克隆(复制)为工作仓库。用户的工作 Git 仓库中的更新文件随后会被“推送”到 Git 服务器上的远程仓库以实现同步。

远程仓库也可以是一种共享类型()Git 仓库,位于便利的位置,例如在共享网络资源上。要使用 Git 命令行工具创建一个共享的远程 Git 仓库,请使用 git init --bare 命令。

在Git系统中建立Altium Designer项目的方法将取决于公司的基础设施和实践,并将涉及到Altium Designer之外的工具和流程。然而,一旦项目进入版本控制系统并作为本地工作仓库可用,使用Altium Designer中的Git版本控制系统与使用SVN版本控制系统几乎没有区别。

将项目添加到Git

举例来说,可以使用基本的Git命令行工具将现有的Altium Designer项目添加到本地Git仓库。采用这种方法,项目文件夹成为本地(工作)Git仓库,这个仓库被链接并最终更新到一个可用的远程Git仓库。

在这里,工具被用来:

  1. 在项目文件夹中创建(初始化)工作 Git 仓库。
  2. 将项目文件添加到 Git 版本控制中。文件规范 *.* 可以添加文件但不包括文件夹。
  3. 指定与网络服务器上的共享远程 Git 仓库的链接引用PCrepo 是远程仓库 URL 的指定本地别名。

项目正在添加到本地Git仓库中

以下的提交(Commit)推送(Push)过程也可以使用命令行工具完成,但在这个例子中,步骤是在Altium Designer中完成的,如下所述。
当项目在Altium Designer中打开时,其文件在项目存储管理器面板中的状态为计划添加)。当文件提交到工作仓库后,文件状态变为领先服务器),因为它们尚未在远程Git仓库中进行版本控制。

  计划添加和领先于服务器的文件

推送命令将更新本地仓库文件到远程Git服务器,这可能需要针对目标仓库的有效凭证——这是一次性过程。请注意,在Altium Designer中,提交推送操作可以通过一个动作来调用(),但在这里为了解释目的,它们是分开完成的。

在提供有效凭证后更新文件

现在完全处于Git版本控制之下的Altium Designer项目,通过远程Git仓库变得可供其他用户使用。例如,另一个用户可以克隆仓库到他们的本地机器,并最终将他们编辑过的文件推送回远程仓库,以实现协作工作流程。

请注意,上述过程只是一个手动示例,说明如何将项目添加到远程Git服务器。已建立的Git VCS安装很可能拥有GUI工具或自动化系统,这些工具或系统在管理员控制下,使得建立和检索工作中的VCS项目变得简单直接。

Altium 工作区就是一个高级的基于服务器的系统示例,它使用带有自动化功能的Git仓库,支持透明的VCS交互。

克隆一个Git仓库

已添加到 Git 版本控制的本地项目可以通过 Altium Designer 从项目的本地文件夹(工作仓库)进行编辑,然后提交的更改会更新到远程 Git 仓库。本地仓库和远程仓库通过 VCS 推送命令链接并最终同步。

希望合作设计的其他用户可以通过克隆远程 Git 仓库到本地工作仓库来访问项目。虽然从远程 Git 仓库访问文件的方法会因公司系统和方法而异,但将内容从远程仓库克隆到本地工作仓库的基本方式是使用 Git 命令;git clone [远程仓库 URL] [目标工作仓库文件夹],如下图所示。

提交的更改已更新到远程Git仓库

该过程将复制共享的远程仓库作为本地工作仓库,并自动检出主分支的最新(HEAD)修订版本。然后可以在Altium Designer中编辑、保存并提交到VCS的文件,并最终推送回远程Git仓库。

连接到现有的Git仓库

Altium Designer 不提供创建新的 Git 仓库或连接到现有仓库的控制。然而,您可以通过其他方式(这是 Git 用户群体偏好的传统技术)有效地连接到这类现有仓库。为此:

  1. 创建您的远程 Git 仓库,或访问您公司的外部仓库 —— 其中存储着您的 Altium Designer 项目。
  2. 克隆仓库以创建您的本地工作 Git 仓库。
  3. 从本地仓库中打开一个 Altium Designer 项目。

Altium Designer 将识别该项目处于基于 Git 的版本控制仓库中,并提供与版本控制系统(VCS)相关的状态、命令/功能来处理文件(包括提交(到本地工作 Git 仓库)和推送(从本地 Git 仓库到远程 Git 仓库))。

AI-LocalizedAI-localized
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
功能可用性

您可使用的功能取决于您所选择的 Altium 解决方案 —— Altium DevelopAltium Agile(Agile Teams 或 Agile Enterprise 版本),或仍在有效订阅期内的 Altium Designer。

如果您在软件中未找到文中提及的功能,请联系 Altium 销售团队了解更多信息。

旧版文档

Altium Designer 文档不再提供版本区分。如果您需要访问 Altium Designer 旧版本的文档,请前往其他安装程序页面的旧版文档部分。

Content