Skip to content

Commit bb9afcf

Browse files
committed
build(release): exclude devguide.md from version marker checks (#4185)
`docs/devguide.md` documents how to use `VERSION_NEXT_*` markers, which causes the release workflow version marker check to fail on release branches. Exclude `devguide.md` from the version marker check script and the release tool replacement patterns. Work towards #4175
1 parent ab982d4 commit bb9afcf

3 files changed

Lines changed: 11 additions & 1 deletion

File tree

‎.github/workflows/check_version_markers.sh‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,11 @@ fi
1717
grep_exit_code=0
1818
# Exclude dot directories, specifically, this file so that we don't
1919
# find the substring we're looking for in our own file.
20-
# Exclude CONTRIBUTING.md, RELEASING.md because they document how to use these strings.
20+
# Exclude CONTRIBUTING.md, RELEASING.md, and devguide.md because they document
21+
# how to use these strings.
2122
grep --exclude=CONTRIBUTING.md \
2223
--exclude=RELEASING.md \
24+
--exclude=devguide.md \
2325
--exclude-dir=.* \
2426
--exclude-dir=release \
2527
VERSION_NEXT_ -r || grep_exit_code=$?

‎dev/release/utils.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ def semver_type(value):
3232
"./bazel-*/*",
3333
"./CONTRIBUTING.md",
3434
"./RELEASING.md",
35+
"./docs/devguide.md",
3536
"./dev/release/*",
3637
"./tests/tools/private/release/*",
3738
]

‎tests/tools/private/release/utils_test.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,10 @@ def test_replace_version_next_excludes_bazel_dirs(release_tool_env):
258258
tests_dir.mkdir(parents=True)
259259
(tests_dir / "mock_file.bzl").write_text(mock_file_content)
260260

261+
docs_dir = release_tool_env.git_root / "docs"
262+
docs_dir.mkdir(parents=True)
263+
(docs_dir / "devguide.md").write_text(mock_file_content)
264+
261265
version = "0.28.0"
262266

263267
# Act
@@ -276,6 +280,9 @@ def test_replace_version_next_excludes_bazel_dirs(release_tool_env):
276280
new_content = (tests_dir / "mock_file.bzl").read_text()
277281
assert "VERSION_NEXT_FEATURE" in new_content
278282

283+
new_content = (docs_dir / "devguide.md").read_text()
284+
assert "VERSION_NEXT_FEATURE" in new_content
285+
279286

280287
def test_determine_next_version_ignores_agents_markers(mocker, release_tool_env):
281288
mocker.patch("dev.release.git.Git.get_current_branch", return_value="main")

0 commit comments

Comments
 (0)