summaryrefslogtreecommitdiff
path: root/xmake/modules/devel/git/support.lua
blob: 5211d62d204a5fffc0f3d1df5f4ea9e09e947c9a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
--!A cross-platform build utility based on Lua
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
--     http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
-- Copyright (C) 2015-present, Xmake Open Source Community.
--
-- @author      ruki
-- @file        support.lua
--

-- imports
import("core.base.option")
import("core.base.semver")
import("lib.detect.find_tool")

-- get git version
function _git_version()
    local git_version = _g.git_version
    if git_version == nil then
        local git = assert(find_tool("git", {version = true}), "git not found!")
        if git.version then
            git_version = git.version
        end
        _g.git_version = git_version or false
    end
    return git_version or nil
end

-- can clone tag?
-- @see https://github.com/xmake-io/xmake/issues/4151
function can_clone_tag()
    local can = _g.can_clone_tag
    if can == nil then
        local git_version = _git_version()
        if git_version and semver.compare(git_version, "1.7.10") >= 0 then
            can = true
        end
        _g.can_clone_tag = can or false
    end
    return can or false
end

-- can clone with --shallow-submodules?
-- @see https://github.com/xmake-io/xmake/issues/4151
function can_shallow_submodules()
    local can = _g.can_shallow_submodules
    if can == nil then
        local git_version = _git_version()
        if git_version and semver.compare(git_version, "2.9.0") >= 0 then
            can = true
        end
        _g.can_shallow_submodules = can or false
    end
    return can or false
end

-- can clone with --filter=tree:0?
-- @see https://github.com/xmake-io/xmake/issues/6246
function can_treeless()
    local can = _g.can_treeless
    if can == nil then
        local git_version = _git_version()
        if git_version and semver.compare(git_version, "2.16.0") >= 0 then
            can = true
        end
        _g.can_treeless = can or false
    end
    return can or false
end

-- can sparse checkout?
-- @see https://github.com/xmake-io/xmake/issues/6071
-- https://github.blog/open-source/git/bring-your-monorepo-down-to-size-with-sparse-checkout/
function can_sparse_checkout()
    local can = _g.can_sparse_checkout
    if can == nil then
        local git_version = _git_version()
        if git_version and semver.compare(git_version, "2.25.0") >= 0 then
            can = true
        end
        _g.can_sparse_checkout = can or false
    end
    return can or false
end