vdm: 通用版本化依赖管理器

vdm是一种替代Git子模块的方案，用于以更合理的方式管理任意外部依赖。与其他尝试解决这个问题的工具不同，vdm是与语言无关的，可用于任何需要远程开发资源的目的。

vdm可用于多种不同目的，但最常见的是作为跟踪外部依赖的方式，这些依赖是您自己的代码可能需要的，但没有特定语言的原生方式来指定。一些例子可能是：

• 您有一个共享的CI仓库，需要从中访问通用shell脚本、托管构建任务等。

• 您正在构建和测试后端应用程序，需要测试从中提供前端代码，而您的团队将前端代码存储在另一个仓库中。

• 您的团队使用协议缓冲区，您需要能够导入其他松散的.proto文件来生成自己的代码。

vdm让您可以清晰地指定所有这些远程依赖及更多，并在需要时检索它们。

入门

安装

可以从GitHub发布页面安装vdm。主要平台和架构都有压缩的二进制文件，这些在资产文件名中有所指示。例如，如果您使用M2 macOS笔记本电脑，您需要下载vdm_darwin-arm64.tar.gz文件，并将其解压到$PATH中的某个位置。

如果您有最新版本的Go工具链，也可以使用go来安装或运行vdm：

go install github.com/opensourcecorp/vdm@<vX.Y.Z|latest>
# 或
go run github.com/opensourcecorp/vdm@<vX.Y.Z|latest> ...

使用方法

首先，您需要一个vdm规范文件，这只是一个YAML（或JSON）文件，指定所有外部依赖以及（通常）它们的版本和您希望它们在文件系统中的位置：

remotes:

  - type:       "git" # 默认类型，可以省略
    remote:     "https://github.com/opensourcecorp/go-common" # 可以指定为'git@...'以使用SSH
    local_path: "./deps/go-common"
    version:    "v0.2.0" # 标签示例；也可以是分支、提交哈希或'latest'

  - type:       "file" # 'file'类型假定版本包含在remote字段中，所以可以省略'version'
    remote:     "https://raw.githubusercontent.com/googleapis/googleapis/master/google/api/http.proto"
    local_path: "./deps/proto/http/http.proto"

您可以在该数组中指定任意数量的依赖项，并将它们存储在任何位置。默认情况下，这个规范文件名为vdm.yaml，位于调用位置（可能是您的仓库根目录），但您可以随意命名，并使用--spec-file标志指向它。

一旦有了规范文件，只需运行：

vdm sync

vdm将处理规范文件，按指定检索依赖项，并将它们放在您指定的位置。默认情况下，vdm sync还会删除每个git远程的本地.git目录，以免影响您的本地Git树。如果要更改远程的版本/修订，只需更新规范文件并再次运行vdm sync。

使用上述示例规范文件运行vdm sync后，您的目录树将类似于：

./vdm.yaml
./deps/
    go-common/
        <该仓库中的内容>
    http.proto

依赖项

vdm作为每个平台的静态链接二进制文件分发，没有特定语言的依赖。但请注意，截至撰写本文时，如果指定任何git远程类型，vdm确实依赖于已安装的git。如果在$PATH中找不到git，vdm将显示一个信息性错误。

关于认证的说明

vdm完全不涉及认证/授权管理。如果规范文件中的远程依赖于特定的认证设置（SSH密钥、HTTP基本认证如.netrc文件、.npmrc配置文件等），这些设置超出了vdm的范围。如有需要，您需要确保在运行vdm命令之前正确配置认证。

未来工作

• 使同步机制更加健壮，以便在规范文件更改以删除远程时，它们会自动清理。

• 添加--keep-git-dir标志，使git远程类型在克隆时不删除.git目录。

• 支持更多类型，不仅限于git和file，并改进file类型