Add :depth option to git deps #13128
Conversation
There was a problem hiding this comment.
I tried to make sure the new :depth option plays well with the existing options and can be extended later if needed, while keeping things simple. Recent Git versions support things like submodule depth, depth since date, etc.
Despite my testing efforts, I acknowledge the complexity of dealing with Git and the possibility of breaking users, so let's proceed with caution 😄
| @@ -282,6 +321,8 @@ defmodule Mix.SCM.Git do | |||
| end | |||
|
|
|||
| defp default_branch() do | |||
| # Note: the `set-head -a` command requires the remote reference to be | |||
| # fetched first. | |||
There was a problem hiding this comment.
Added this note because the most obvious code would be to "compute" rev in checkout/2 in a single expression as it used to be, but that doesn't work.
| test "changing refspec updates retaining depth" do | ||
| [last, first | _] = get_git_repo_revs("git_repo") | ||
|
|
||
| Process.put(:git_repo_opts, ref: first, depth: 1) | ||
|
|
||
| in_fixture("no_mixfile", fn -> | ||
| Mix.Project.push(GitApp) | ||
|
|
||
| Mix.Tasks.Deps.Get.run([]) | ||
| message = "* Getting git_repo (#{fixture_path("git_repo")} - #{first})" | ||
| assert_received {:mix_shell, :info, [^message]} | ||
| assert_shallow("deps/git_repo", 1) | ||
| assert File.read!("mix.lock") =~ first | ||
|
|
||
| # Change refspec | ||
| update_dep(ref: last, depth: 1) | ||
| Mix.Tasks.Deps.Get.run([]) | ||
| assert_shallow("deps/git_repo", 1) | ||
| assert File.read!("mix.lock") =~ last | ||
| end) | ||
| end |
There was a problem hiding this comment.
This is intended to cover José's concern in the original conversation.
The way to call git fetch can handle both changing the :depth and the :tag, :branch or :ref.
| end | ||
|
|
||
| test "can be used with subdir" do | ||
| Process.put(:git_repo_opts, subdir: "sparse_dir", depth: 1) |
There was a problem hiding this comment.
I noticed that the :subdir options forces the creation of the subdir, even if it doesn't exist in the repository. It was curious to me that the test fixtures don't create a subdir named "subdir" (what the existing subdir test uses), and so used the "sparse_dir" path here, and also asserting it contains what we expect (unlike the existing subdir test).
rhcarvalho
force-pushed
the
deps-git-shallow-clone
branch
from
fcdf8c0 to
8cd49b3
Compare
|
Tests are failing due to the changes in the format rendering. It should be a quick fix, can you please take a look? |
|
I'll have a look during the week and also think about possible corner cases
better.
…On Sat, Nov 25, 2023, 04:49 José Valim ***@***.***> wrote:
Tests are failing due to the changes in the format rendering. It should be
a quick fix, can you please take a look?
—
Reply to this email directly, view it on GitHub
<#13128 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAAVV43XJU3KYMHJZIJIZ7DYGFTETAVCNFSM6AAAAAA7SXGWHWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMRWGIYDKMJTGM>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
This allows for faster clones that transfer less data over the network and take less space in disk, for cases when the full history is not needed.
rhcarvalho
force-pushed
the
deps-git-shallow-clone
branch
from
8cd49b3 to
849782c
Compare
|
|
💚 💙 💜 💛 ❤️ |
Adding a note about a new option added in elixir-lang#13128.
Adding a note about a new option added in #13128.
Adding a note about a new option added in elixir-lang#13128.
Based on conversation at https://elixirforum.com/t/mix-git-dependency-with-shallow-clone/59440.
This allows for faster clones that transfer less data over the network and take less space in disk, for cases when the full history is not needed.
As a particular example, and how I plan to use this, setting
depth: 1allows us to update the Phoenix Heroicons dependency pulling in as little data as possible (see phoenixframework/phoenix#5622 (comment)).