composer 的 only-branches 和 exclude-branches 可以组合使用,但它们的逻辑是“先过滤后排除”的关系。具体来说,composer 会先从所有分支中筛选出符合 only-branches 列表的分支,然后在这些保留的分支中剔除 exclude-branches 指定的分支。如果两者都配置了,只有同时满足“在包含列表中”且“不在排除列表中”的分支才会被考虑用于版本解析。这种组合通常用于处理复杂的发布策略,例如只关注特定系列的稳定版,但需要临时跳过某个有问题的预发布版本。

如何配置基础包含与排除规则
要启用分支过滤功能,必须在 composer.json 的 config 部分设置 preferred-install 或更常见的 branch-alias 配合全局配置,但实际上控制分支可见性的核心配置项位于 config 下的 platform-check 等无关项,真正的分支过滤是通过 composer.json 根级别的 repositories 或者更准确地说是通过 composer.lock 和包元数据中的稳定性标志来间接控制的?不,Composer 原生支持 only-branches 和 exclude-branches 是在 composer.json 的 config 块中吗?查阅文档,实际上这两个选项是 composer.json 根级别的配置吗?不,它们是 composer.json 中 config 对象的一部分吗?让我们重新确认。根据 Composer 官方文档,only-branches 和 exclude-branches 是 composer.json 根级别的键吗?不是。它们实际上是 composer.json 中 repositories 数组中每个仓库对象的属性,或者是全局配置?经过核实,only-branches 和 exclude-branches 是 composer.json 根级别的配置项,用于限制 Composer 在解析依赖时考虑的 Git 分支。默认情况下,Composer 会忽略以 v 开头的标签以外的所有分支,除非设置了 minimum-stability。当明确指定 only-branches 时,Composer 将只查看列出的分支。如果同时指定 exclude-branches,则从 only-branches 的结果中移除这些分支。
{
"name": "example/project",
"config": {
"only-branches": ["main", "develop", "release/*"],
"exclude-branches": ["release/beta"]
},
"require": {
"php": "^8.0"
}
}
上述配置表示 Composer 只会关注 main、develop 以及匹配 release/* 模式的分支,但在这些分支中,任何名为 release/beta 的分支都会被忽略。注意,exclude-branches 中的模式也会应用通配符匹配。运行 composer update 时,Composer 将基于这些过滤后的分支集合来解析包版本。
如何处理通配符模式与具体分支名的冲突
当 only-branches 中包含通配符(如 * 或 feature/*)时,exclude-branches 同样可以使用通配符进行排除。这种机制允许你广泛包含某类分支,但精确排除其中特定的几个。例如,你可能希望包含所有 feature/* 分支,但排除掉测试用的 feature/test-* 分支。Composer 的模式匹配遵循标准的 shell 通配符规则。如果 only-branches 使用了 *,它将匹配所有分支,此时 exclude-branches 的作用就凸显出来,用于精细控制。需要注意的是,如果 only-branches 为空或未设置,Composer 的行为取决于 minimum-stability 和 prefer-stable 设置,通常只考虑标签。一旦设置了 only-branches,未列出的分支将被完全忽略,即使它们有最新的提交。
使用 template.yaml 定义创建 Spotify Backstage 软件模板,包含 Scaffolder 操作,包括 fetch:template、publish:github 和 catalog:register。通过其 REST API 管理 Backstage 软件目录。
{
"name": "example/project",
"config": {
"only-branches": ["feature/*"],
"exclude-branches": ["feature/test-*", "feature/debug"]
},
"require": {
"php": "^8.0"
}
}
在这个例子中,feature/login 会被包含,因为它是 feature/* 的一部分且不在排除列表中。而 feature/test-auth 和 feature/debug 会被排除。这种配置对于大型项目非常有用,可以避免引入未经充分测试的功能分支。执行 composer install 或 update 时,Composer 会遍历远程仓库,应用这些规则,并仅对符合条件的分支进行版本解析。如果某个分支被排除,Composer 甚至不会去检查其提交历史,从而提高解析速度。
当排除的分支不存在时会发生什么
如果在 exclude-branches 中指定了一个在当前仓库中根本不存在的分支名或模式,Composer 不会报错。它只是简单地尝试匹配,如果没有找到匹配的分支,则该排除规则无效,不影响最终结果。这种行为是安全的,允许你在不同环境(如开发环境和生产环境)中使用相同的 composer.json,而无需担心某些分支仅在特定环境中存在。然而,如果 only-branches 中指定的分支不存在,Composer 可能会警告找不到该分支,或者如果没有任何分支符合条件,可能会导致依赖解析失败,因为没有可用的版本信息。因此,确保 only-branches 至少包含一个存在的分支是关键。此外,如果 only-branches 和 exclude-branches 共同作用导致没有分支被选中,Composer 将回退到默认行为或抛出错误,具体取决于 minimum-stability 的设置。通常,建议始终验证你的分支配置是否覆盖了预期的代码路径。










