github/esphome
2
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2026-09-22 12:38:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

[git] Address PR review feedback

Browse Source 
- Add `--` terminator before submodule paths (both clone and refresh
  paths) so a path beginning with `-` cannot be parsed as a git option.
- Reword the refresh-fetch comment: this fetch also runs when ref is
  None, in which case it pulls the remote default branch.
This commit is contained in:
J. Nick Koston
2026-04-26 04:08:43 -05:00
parent b3a57d1395
commit e907e71101
2 changed files with 13 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
esphome/git.py
+9 -6
View File
@@ -141,7 +141,8 @@ def clone_or_update(
"Initializing submodules (%s) for %s", ", ".join(submodules), key
)
run_git_command(
["git", "submodule", "update", "--init", "--depth=1"] + submodules,
["git", "submodule", "update", "--init", "--depth=1", "--"]
+ submodules,
git_dir=repo_dir,
)
except GitException:
@@ -184,10 +185,11 @@ def clone_or_update(
git_dir=repo_dir,
)
# Fetch remote ref. --depth=1 keeps the clone shallow while
# still picking up new commits when the remote tip moves: a
# shallow fetch always retrieves the current tip of the
# requested ref, then reset --hard FETCH_HEAD updates the
# Fetch from the remote. --depth=1 keeps the clone shallow
# while still picking up new commits when the remote tip
# moves: a shallow fetch retrieves the current tip being
# fetched, whether that's an explicit ref or the remote's
# default branch, then reset --hard FETCH_HEAD updates the
# working tree to it.
cmd = ["git", "fetch", "--depth=1", "--", "origin"]
if ref is not None:
@@ -238,7 +240,8 @@ def clone_or_update(
"Updating submodules (%s) for %s", ", ".join(submodules), key
)
run_git_command(
["git", "submodule", "update", "--init", "--depth=1"] + submodules,
["git", "submodule", "update", "--init", "--depth=1", "--"]
+ submodules,
git_dir=repo_dir,
)
tests/unit_tests/test_git.py
+4
View File
@@ -855,6 +855,9 @@ def test_clone_with_submodules_uses_shallow_submodule_update(
cmd = submodule_calls[0][0][0]
assert "--depth=1" in cmd
assert "components/foo" in cmd
# The `--` terminator must precede the submodule paths so a path
# beginning with `-` cannot be parsed as an option.
assert cmd.index("--") < cmd.index("components/foo")
def test_refresh_fetch_is_shallow(tmp_path: Path, mock_run_git_command: Mock) -> None:
@@ -909,6 +912,7 @@ def test_refresh_submodule_update_is_shallow(
cmd = submodule_calls[0][0][0]
assert "--depth=1" in cmd
assert "components/foo" in cmd
assert cmd.index("--") < cmd.index("components/foo")
def test_refresh_picks_up_new_remote_commits(