release: false should be the lowest priority rule
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 48/100
- Issue 类型
- 缺陷
- 描述清晰度
- 描述清楚
- 活跃度
- 停滞
- 技术栈
- javascript
调研方向
从链接测试附近的 test/analyze-commit.test.js 开始,并阅读 lib/compare-release-types.js,尤其是 RELEASE_TYPES 的比较方式。在更改行为之前运行 analyzer 测试。完成的标准是:当后续规则使用 release: false 时,带 scope 的规则仍保留较高的 release 值,同时现有的 release-priority 用例仍然通过。
由索引模型根据 Issue 内容生成。
描述
Consider what happens when we expand this test to apply scope:
test('Return "false" for release type ONLY if the matching rule has no higher "release"', (t) => {
const commit = {type: 'fix', scope: 'frontend'};
t.is(analyzeCommit([
{type: 'fix', scope: 'frontend', release: 'patch'},
{type: 'fix', scope: '*', release: false} // <----- this should NOT override 'patch'
], commit), 'patch');
});
so this ruleset says "release fixes as 'patch' for the frontend, but don't release any other fixes in any other scopes"
this test will fail. because of this line: https://github.com/semantic-release/commit-analyzer/blob/master/lib/compare-release-types.js#L11
RELEASE_TYPES doesn't include false or null. so the algorithm starts to analyze our commit using our ruleset, and correctly identifies it as a 'patch'. then it considers the next rule, which says release === false. false is not in RELEASE_TYPES, so compareReleaseTypes() returns true, and the release value for the commit is incorrectly set to false, instead of patch.
this is problematic because it violates the advertised behavior of the release configuration: a commit will always be given the highest possible release value available from the given ruleset. if we consider "no release" the lowest possible release value - as I think is intuitive - then any other release value should take precedence.
the current algorithm treats no release as a special case without priority. or rather, it implicitly treats no release as the highest possible priority of release type, which doesn't make sense. no release cannot be the biggest release.
the current behavior thus renders the use case I've alluded to impossible, so i'll spell that use case out more specifically.
if you have a repo with several scopes, then you might want rules that govern how some scopes get released, and you might want only some of those scopes to get released ever. for example, if you have a project like this:
project/
- frontend
- backend
- shared-tools
you might want to say something like this:
"release any frontend or backend commits according to standard rules. fix:patch, feat:minor, break:major. but don't ever release any commits in shared-tools no matter what."
here's an example of what that ruleset might look like:
[
{scope: 'frontend', type: 'fix', release: 'patch'},
{scope: 'frontend', type: 'feat', release: 'minor'},
{scope: 'frontend', type: 'breaking', release: 'major'},
{scope: 'backend', type: 'fix', release: 'patch'},
{scope: 'backend', type: 'feat', release: 'minor'},
{scope: 'backend', type: 'breaking', release: 'major'},
{scope: '*', type: '*', release: false}
]
but for the reasons explained so far, that ruleset will never do what you expect. it will make any release impossible.
the simplest fix and what i would recommend is adding false, and null to the end of the list of RELEASE_TYPES. this would be a breaking change for people who expect release: false|null to override any other possible release value. but that perspective doesn't make any sense, and renders reasonable workflows impossible.
- 主要语言
- JavaScript
- 星标
- 446
- 派生
- 82
- 平均合并
- 4 小时 10 分钟
- 30 天内合并 PR
- 10
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
semantic-release/commit-analyzer 的其他 Issue
-
released on @beta
难度 2/5 1-3 小时 新手友好度 65/100
semantic-release/commit-analyzer#921 · 8 条评论 · 7 个 reaction ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 42/100
semantic-release/commit-analyzer#805 · 6 条评论 ·
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 25/100
semantic-release/commit-analyzer#802 · 1 条评论 ·
维护者通常 1 天内回复
-
Unexpected major release because commit description includes a line starting with "Breaking change"未关闭
难度 3/5 1-2 天 新手友好度 35/100
semantic-release/commit-analyzer#776 · 1 条评论 ·
维护者通常 1 天内回复
-
Exclamation mark (!) after type/scope completely ignores commit可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭released on @beta
难度 3/5 1-2 天 新手友好度 55/100
semantic-release/commit-analyzer#759 · 13 条评论 · 6 个 reaction ·
维护者通常 1 天内回复
查看 semantic-release/commit-analyzer 的全部 Issue
相似的 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 70/100
maproulette/maproulette-frontend#2944 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 88/100
jaegertracing/jaeger-ui#4618 ·
维护者通常 1 天内回复
-
area:plugins enhancement platform:vscode
难度 2/5 1-3 小时 新手友好度 88/100
anthropics/claude-code#103166 ·
维护者通常 1 天内回复
-
check:failed logos:add
难度 1/5 1 小时以内 新手友好度 78/100
-
[workshop-sim] Improve: Add verifiable checkpoint and bridge to Step 5 (What Are Agentic Workflows?)未关闭feedback simulation workshop
难度 2/5 1-3 小时 新手友好度 88/100
githubnext/gh-aw-workshop#4715 ·
维护者通常 1 天内回复