Class: Git::RemoteInfo

Inherits:
Data
  • Object
show all
Defined in:
lib/git/remote_info.rb

Overview

Value object representing a configured git remote

Each instance holds the parsed configuration for a single remote as read from the repository's git config. Multi-value fields (:url, :push_url, :fetch, :push) are always Array<String> (never nil; may be empty). All other fields are nilable except :name.

Examples:

Minimal remote (fetch-only, one URL)

info = Git::RemoteInfo.new(
  name: 'origin',
  url: ['https://github.com/ruby-git/ruby-git.git'],
  push_url: [],
  fetch: ['+refs/heads/*:refs/remotes/origin/*'],
  push: []
)
info.name   # => "origin"
info.url    # => ["https://github.com/ruby-git/ruby-git.git"]
info.prune  # => nil

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, url: [], push_url: [], fetch: [], push: [], mirror: nil, skip_default_update: nil, tag_opt: nil, prune: nil, prune_tags: nil, receivepack: nil, uploadpack: nil, promisor: nil, partial_clone_filter: nil, vcs: nil) ⇒ Git::RemoteInfo

Create a new RemoteInfo

Parameters:

  • name (String) —

    the name of the remote (required)

  • url (Array<String>) (defaults to: []) —

    fetch URLs (default [])

  • push_url (Array<String>) (defaults to: []) —

    push URLs (default [])

  • fetch (Array<String>) (defaults to: []) —

    fetch refspecs (default [])

  • push (Array<String>) (defaults to: []) —

    push refspecs (default [])

  • mirror (Boolean, nil) (defaults to: nil) —

    mirror flag (default nil)

  • skip_default_update (Boolean, nil) (defaults to: nil) —

    skip-default-update flag (default nil)

  • tag_opt (String, nil) (defaults to: nil) —

    tag-fetching option (default nil)

  • prune (Boolean, nil) (defaults to: nil) —

    prune flag (default nil)

  • prune_tags (Boolean, nil) (defaults to: nil) —

    prune-tags flag (default nil)

  • receivepack (String, nil) (defaults to: nil) —

    receive-pack path (default nil)

  • uploadpack (String, nil) (defaults to: nil) —

    upload-pack path (default nil)

  • promisor (Boolean, nil) (defaults to: nil) —

    promisor flag (default nil)

  • partial_clone_filter (String, nil) (defaults to: nil) —

    partial-clone filter (default nil)

  • vcs (String, nil) (defaults to: nil) —

    VCS type (default nil)



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/git/remote_info.rb', line 121

def initialize(
  name:,
  url: [],
  push_url: [],
  fetch: [],
  push: [],
  mirror: nil,
  skip_default_update: nil,
  tag_opt: nil,
  prune: nil,
  prune_tags: nil,
  receivepack: nil,
  uploadpack: nil,
  promisor: nil,
  partial_clone_filter: nil,
  vcs: nil
)
  super(
    name:, url: Array(url), push_url: Array(push_url), fetch: Array(fetch),
    push: Array(push), mirror:, skip_default_update:, tag_opt:, prune:,
    prune_tags:, receivepack:, uploadpack:, promisor:, partial_clone_filter:,
    vcs:
  )
end

Instance Attribute Details

#fetch ⇒ Array<String> (readonly)

Returns the fetch refspec(s) for this remote (remote.<name>.fetch).

Returns:

  • (Array<String>) —

    the fetch refspec(s) for this remote (remote.<name>.fetch)



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/git/remote_info.rb', line 70

RemoteInfo = Data.define(
  :name,
  :url,
  :push_url,
  :fetch,
  :push,
  :mirror,
  :skip_default_update,
  :tag_opt,
  :prune,
  :prune_tags,
  :receivepack,
  :uploadpack,
  :promisor,
  :partial_clone_filter,
  :vcs
) do
  # Create a new RemoteInfo
  #
  # @param name [String] the name of the remote (required)
  #
  # @param url [Array<String>] fetch URLs (default `[]`)
  #
  # @param push_url [Array<String>] push URLs (default `[]`)
  #
  # @param fetch [Array<String>] fetch refspecs (default `[]`)
  #
  # @param push [Array<String>] push refspecs (default `[]`)
  #
  # @param mirror [Boolean, nil] mirror flag (default `nil`)
  #
  # @param skip_default_update [Boolean, nil] skip-default-update flag (default `nil`)
  #
  # @param tag_opt [String, nil] tag-fetching option (default `nil`)
  #
  # @param prune [Boolean, nil] prune flag (default `nil`)
  #
  # @param prune_tags [Boolean, nil] prune-tags flag (default `nil`)
  #
  # @param receivepack [String, nil] receive-pack path (default `nil`)
  #
  # @param uploadpack [String, nil] upload-pack path (default `nil`)
  #
  # @param promisor [Boolean, nil] promisor flag (default `nil`)
  #
  # @param partial_clone_filter [String, nil] partial-clone filter (default `nil`)
  #
  # @param vcs [String, nil] VCS type (default `nil`)
  #
  # @return [Git::RemoteInfo]
  #
  def initialize(
    name:,
    url: [],
    push_url: [],
    fetch: [],
    push: [],
    mirror: nil,
    skip_default_update: nil,
    tag_opt: nil,
    prune: nil,
    prune_tags: nil,
    receivepack: nil,
    uploadpack: nil,
    promisor: nil,
    partial_clone_filter: nil,
    vcs: nil
  )
    super(
      name:, url: Array(url), push_url: Array(push_url), fetch: Array(fetch),
      push: Array(push), mirror:, skip_default_update:, tag_opt:, prune:,
      prune_tags:, receivepack:, uploadpack:, promisor:, partial_clone_filter:,
      vcs:
    )
  end
end

#mirror ⇒ Boolean? (readonly)

Returns true/false per remote.<name>.mirror, or nil when not set.

Returns:

  • (Boolean, nil) —

    true/false per remote.<name>.mirror, or nil when not set



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/git/remote_info.rb', line 70

RemoteInfo = Data.define(
  :name,
  :url,
  :push_url,
  :fetch,
  :push,
  :mirror,
  :skip_default_update,
  :tag_opt,
  :prune,
  :prune_tags,
  :receivepack,
  :uploadpack,
  :promisor,
  :partial_clone_filter,
  :vcs
) do
  # Create a new RemoteInfo
  #
  # @param name [String] the name of the remote (required)
  #
  # @param url [Array<String>] fetch URLs (default `[]`)
  #
  # @param push_url [Array<String>] push URLs (default `[]`)
  #
  # @param fetch [Array<String>] fetch refspecs (default `[]`)
  #
  # @param push [Array<String>] push refspecs (default `[]`)
  #
  # @param mirror [Boolean, nil] mirror flag (default `nil`)
  #
  # @param skip_default_update [Boolean, nil] skip-default-update flag (default `nil`)
  #
  # @param tag_opt [String, nil] tag-fetching option (default `nil`)
  #
  # @param prune [Boolean, nil] prune flag (default `nil`)
  #
  # @param prune_tags [Boolean, nil] prune-tags flag (default `nil`)
  #
  # @param receivepack [String, nil] receive-pack path (default `nil`)
  #
  # @param uploadpack [String, nil] upload-pack path (default `nil`)
  #
  # @param promisor [Boolean, nil] promisor flag (default `nil`)
  #
  # @param partial_clone_filter [String, nil] partial-clone filter (default `nil`)
  #
  # @param vcs [String, nil] VCS type (default `nil`)
  #
  # @return [Git::RemoteInfo]
  #
  def initialize(
    name:,
    url: [],
    push_url: [],
    fetch: [],
    push: [],
    mirror: nil,
    skip_default_update: nil,
    tag_opt: nil,
    prune: nil,
    prune_tags: nil,
    receivepack: nil,
    uploadpack: nil,
    promisor: nil,
    partial_clone_filter: nil,
    vcs: nil
  )
    super(
      name:, url: Array(url), push_url: Array(push_url), fetch: Array(fetch),
      push: Array(push), mirror:, skip_default_update:, tag_opt:, prune:,
      prune_tags:, receivepack:, uploadpack:, promisor:, partial_clone_filter:,
      vcs:
    )
  end
end

#name ⇒ String (readonly)

Returns the name of the remote (e.g. 'origin').

Returns:

  • (String) —

    the name of the remote (e.g. 'origin')



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/git/remote_info.rb', line 70

RemoteInfo = Data.define(
  :name,
  :url,
  :push_url,
  :fetch,
  :push,
  :mirror,
  :skip_default_update,
  :tag_opt,
  :prune,
  :prune_tags,
  :receivepack,
  :uploadpack,
  :promisor,
  :partial_clone_filter,
  :vcs
) do
  # Create a new RemoteInfo
  #
  # @param name [String] the name of the remote (required)
  #
  # @param url [Array<String>] fetch URLs (default `[]`)
  #
  # @param push_url [Array<String>] push URLs (default `[]`)
  #
  # @param fetch [Array<String>] fetch refspecs (default `[]`)
  #
  # @param push [Array<String>] push refspecs (default `[]`)
  #
  # @param mirror [Boolean, nil] mirror flag (default `nil`)
  #
  # @param skip_default_update [Boolean, nil] skip-default-update flag (default `nil`)
  #
  # @param tag_opt [String, nil] tag-fetching option (default `nil`)
  #
  # @param prune [Boolean, nil] prune flag (default `nil`)
  #
  # @param prune_tags [Boolean, nil] prune-tags flag (default `nil`)
  #
  # @param receivepack [String, nil] receive-pack path (default `nil`)
  #
  # @param uploadpack [String, nil] upload-pack path (default `nil`)
  #
  # @param promisor [Boolean, nil] promisor flag (default `nil`)
  #
  # @param partial_clone_filter [String, nil] partial-clone filter (default `nil`)
  #
  # @param vcs [String, nil] VCS type (default `nil`)
  #
  # @return [Git::RemoteInfo]
  #
  def initialize(
    name:,
    url: [],
    push_url: [],
    fetch: [],
    push: [],
    mirror: nil,
    skip_default_update: nil,
    tag_opt: nil,
    prune: nil,
    prune_tags: nil,
    receivepack: nil,
    uploadpack: nil,
    promisor: nil,
    partial_clone_filter: nil,
    vcs: nil
  )
    super(
      name:, url: Array(url), push_url: Array(push_url), fetch: Array(fetch),
      push: Array(push), mirror:, skip_default_update:, tag_opt:, prune:,
      prune_tags:, receivepack:, uploadpack:, promisor:, partial_clone_filter:,
      vcs:
    )
  end
end

#partial_clone_filter ⇒ String? (readonly)

Returns the partial-clone object filter (remote.<name>.partialclonefilter).

Returns:

  • (String, nil) —

    the partial-clone object filter (remote.<name>.partialclonefilter)



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/git/remote_info.rb', line 70

RemoteInfo = Data.define(
  :name,
  :url,
  :push_url,
  :fetch,
  :push,
  :mirror,
  :skip_default_update,
  :tag_opt,
  :prune,
  :prune_tags,
  :receivepack,
  :uploadpack,
  :promisor,
  :partial_clone_filter,
  :vcs
) do
  # Create a new RemoteInfo
  #
  # @param name [String] the name of the remote (required)
  #
  # @param url [Array<String>] fetch URLs (default `[]`)
  #
  # @param push_url [Array<String>] push URLs (default `[]`)
  #
  # @param fetch [Array<String>] fetch refspecs (default `[]`)
  #
  # @param push [Array<String>] push refspecs (default `[]`)
  #
  # @param mirror [Boolean, nil] mirror flag (default `nil`)
  #
  # @param skip_default_update [Boolean, nil] skip-default-update flag (default `nil`)
  #
  # @param tag_opt [String, nil] tag-fetching option (default `nil`)
  #
  # @param prune [Boolean, nil] prune flag (default `nil`)
  #
  # @param prune_tags [Boolean, nil] prune-tags flag (default `nil`)
  #
  # @param receivepack [String, nil] receive-pack path (default `nil`)
  #
  # @param uploadpack [String, nil] upload-pack path (default `nil`)
  #
  # @param promisor [Boolean, nil] promisor flag (default `nil`)
  #
  # @param partial_clone_filter [String, nil] partial-clone filter (default `nil`)
  #
  # @param vcs [String, nil] VCS type (default `nil`)
  #
  # @return [Git::RemoteInfo]
  #
  def initialize(
    name:,
    url: [],
    push_url: [],
    fetch: [],
    push: [],
    mirror: nil,
    skip_default_update: nil,
    tag_opt: nil,
    prune: nil,
    prune_tags: nil,
    receivepack: nil,
    uploadpack: nil,
    promisor: nil,
    partial_clone_filter: nil,
    vcs: nil
  )
    super(
      name:, url: Array(url), push_url: Array(push_url), fetch: Array(fetch),
      push: Array(push), mirror:, skip_default_update:, tag_opt:, prune:,
      prune_tags:, receivepack:, uploadpack:, promisor:, partial_clone_filter:,
      vcs:
    )
  end
end

#promisor ⇒ Boolean? (readonly)

Returns true/false per remote.<name>.promisor, or nil when not set.

Returns:

  • (Boolean, nil) —

    true/false per remote.<name>.promisor, or nil when not set



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/git/remote_info.rb', line 70

RemoteInfo = Data.define(
  :name,
  :url,
  :push_url,
  :fetch,
  :push,
  :mirror,
  :skip_default_update,
  :tag_opt,
  :prune,
  :prune_tags,
  :receivepack,
  :uploadpack,
  :promisor,
  :partial_clone_filter,
  :vcs
) do
  # Create a new RemoteInfo
  #
  # @param name [String] the name of the remote (required)
  #
  # @param url [Array<String>] fetch URLs (default `[]`)
  #
  # @param push_url [Array<String>] push URLs (default `[]`)
  #
  # @param fetch [Array<String>] fetch refspecs (default `[]`)
  #
  # @param push [Array<String>] push refspecs (default `[]`)
  #
  # @param mirror [Boolean, nil] mirror flag (default `nil`)
  #
  # @param skip_default_update [Boolean, nil] skip-default-update flag (default `nil`)
  #
  # @param tag_opt [String, nil] tag-fetching option (default `nil`)
  #
  # @param prune [Boolean, nil] prune flag (default `nil`)
  #
  # @param prune_tags [Boolean, nil] prune-tags flag (default `nil`)
  #
  # @param receivepack [String, nil] receive-pack path (default `nil`)
  #
  # @param uploadpack [String, nil] upload-pack path (default `nil`)
  #
  # @param promisor [Boolean, nil] promisor flag (default `nil`)
  #
  # @param partial_clone_filter [String, nil] partial-clone filter (default `nil`)
  #
  # @param vcs [String, nil] VCS type (default `nil`)
  #
  # @return [Git::RemoteInfo]
  #
  def initialize(
    name:,
    url: [],
    push_url: [],
    fetch: [],
    push: [],
    mirror: nil,
    skip_default_update: nil,
    tag_opt: nil,
    prune: nil,
    prune_tags: nil,
    receivepack: nil,
    uploadpack: nil,
    promisor: nil,
    partial_clone_filter: nil,
    vcs: nil
  )
    super(
      name:, url: Array(url), push_url: Array(push_url), fetch: Array(fetch),
      push: Array(push), mirror:, skip_default_update:, tag_opt:, prune:,
      prune_tags:, receivepack:, uploadpack:, promisor:, partial_clone_filter:,
      vcs:
    )
  end
end

#prune ⇒ Boolean? (readonly)

Returns true/false per remote.<name>.prune; nil inherits fetch.prune.

Returns:

  • (Boolean, nil) —

    true/false per remote.<name>.prune; nil inherits fetch.prune



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/git/remote_info.rb', line 70

RemoteInfo = Data.define(
  :name,
  :url,
  :push_url,
  :fetch,
  :push,
  :mirror,
  :skip_default_update,
  :tag_opt,
  :prune,
  :prune_tags,
  :receivepack,
  :uploadpack,
  :promisor,
  :partial_clone_filter,
  :vcs
) do
  # Create a new RemoteInfo
  #
  # @param name [String] the name of the remote (required)
  #
  # @param url [Array<String>] fetch URLs (default `[]`)
  #
  # @param push_url [Array<String>] push URLs (default `[]`)
  #
  # @param fetch [Array<String>] fetch refspecs (default `[]`)
  #
  # @param push [Array<String>] push refspecs (default `[]`)
  #
  # @param mirror [Boolean, nil] mirror flag (default `nil`)
  #
  # @param skip_default_update [Boolean, nil] skip-default-update flag (default `nil`)
  #
  # @param tag_opt [String, nil] tag-fetching option (default `nil`)
  #
  # @param prune [Boolean, nil] prune flag (default `nil`)
  #
  # @param prune_tags [Boolean, nil] prune-tags flag (default `nil`)
  #
  # @param receivepack [String, nil] receive-pack path (default `nil`)
  #
  # @param uploadpack [String, nil] upload-pack path (default `nil`)
  #
  # @param promisor [Boolean, nil] promisor flag (default `nil`)
  #
  # @param partial_clone_filter [String, nil] partial-clone filter (default `nil`)
  #
  # @param vcs [String, nil] VCS type (default `nil`)
  #
  # @return [Git::RemoteInfo]
  #
  def initialize(
    name:,
    url: [],
    push_url: [],
    fetch: [],
    push: [],
    mirror: nil,
    skip_default_update: nil,
    tag_opt: nil,
    prune: nil,
    prune_tags: nil,
    receivepack: nil,
    uploadpack: nil,
    promisor: nil,
    partial_clone_filter: nil,
    vcs: nil
  )
    super(
      name:, url: Array(url), push_url: Array(push_url), fetch: Array(fetch),
      push: Array(push), mirror:, skip_default_update:, tag_opt:, prune:,
      prune_tags:, receivepack:, uploadpack:, promisor:, partial_clone_filter:,
      vcs:
    )
  end
end

#prune_tags ⇒ Boolean? (readonly)

Returns true/false per remote.<name>.pruneTags; nil inherits fetch.pruneTags.

Returns:

  • (Boolean, nil) —

    true/false per remote.<name>.pruneTags; nil inherits fetch.pruneTags



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/git/remote_info.rb', line 70

RemoteInfo = Data.define(
  :name,
  :url,
  :push_url,
  :fetch,
  :push,
  :mirror,
  :skip_default_update,
  :tag_opt,
  :prune,
  :prune_tags,
  :receivepack,
  :uploadpack,
  :promisor,
  :partial_clone_filter,
  :vcs
) do
  # Create a new RemoteInfo
  #
  # @param name [String] the name of the remote (required)
  #
  # @param url [Array<String>] fetch URLs (default `[]`)
  #
  # @param push_url [Array<String>] push URLs (default `[]`)
  #
  # @param fetch [Array<String>] fetch refspecs (default `[]`)
  #
  # @param push [Array<String>] push refspecs (default `[]`)
  #
  # @param mirror [Boolean, nil] mirror flag (default `nil`)
  #
  # @param skip_default_update [Boolean, nil] skip-default-update flag (default `nil`)
  #
  # @param tag_opt [String, nil] tag-fetching option (default `nil`)
  #
  # @param prune [Boolean, nil] prune flag (default `nil`)
  #
  # @param prune_tags [Boolean, nil] prune-tags flag (default `nil`)
  #
  # @param receivepack [String, nil] receive-pack path (default `nil`)
  #
  # @param uploadpack [String, nil] upload-pack path (default `nil`)
  #
  # @param promisor [Boolean, nil] promisor flag (default `nil`)
  #
  # @param partial_clone_filter [String, nil] partial-clone filter (default `nil`)
  #
  # @param vcs [String, nil] VCS type (default `nil`)
  #
  # @return [Git::RemoteInfo]
  #
  def initialize(
    name:,
    url: [],
    push_url: [],
    fetch: [],
    push: [],
    mirror: nil,
    skip_default_update: nil,
    tag_opt: nil,
    prune: nil,
    prune_tags: nil,
    receivepack: nil,
    uploadpack: nil,
    promisor: nil,
    partial_clone_filter: nil,
    vcs: nil
  )
    super(
      name:, url: Array(url), push_url: Array(push_url), fetch: Array(fetch),
      push: Array(push), mirror:, skip_default_update:, tag_opt:, prune:,
      prune_tags:, receivepack:, uploadpack:, promisor:, partial_clone_filter:,
      vcs:
    )
  end
end

#push ⇒ Array<String> (readonly)

Returns the push refspec(s) for this remote (remote.<name>.push).

Returns:

  • (Array<String>) —

    the push refspec(s) for this remote (remote.<name>.push)



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/git/remote_info.rb', line 70

RemoteInfo = Data.define(
  :name,
  :url,
  :push_url,
  :fetch,
  :push,
  :mirror,
  :skip_default_update,
  :tag_opt,
  :prune,
  :prune_tags,
  :receivepack,
  :uploadpack,
  :promisor,
  :partial_clone_filter,
  :vcs
) do
  # Create a new RemoteInfo
  #
  # @param name [String] the name of the remote (required)
  #
  # @param url [Array<String>] fetch URLs (default `[]`)
  #
  # @param push_url [Array<String>] push URLs (default `[]`)
  #
  # @param fetch [Array<String>] fetch refspecs (default `[]`)
  #
  # @param push [Array<String>] push refspecs (default `[]`)
  #
  # @param mirror [Boolean, nil] mirror flag (default `nil`)
  #
  # @param skip_default_update [Boolean, nil] skip-default-update flag (default `nil`)
  #
  # @param tag_opt [String, nil] tag-fetching option (default `nil`)
  #
  # @param prune [Boolean, nil] prune flag (default `nil`)
  #
  # @param prune_tags [Boolean, nil] prune-tags flag (default `nil`)
  #
  # @param receivepack [String, nil] receive-pack path (default `nil`)
  #
  # @param uploadpack [String, nil] upload-pack path (default `nil`)
  #
  # @param promisor [Boolean, nil] promisor flag (default `nil`)
  #
  # @param partial_clone_filter [String, nil] partial-clone filter (default `nil`)
  #
  # @param vcs [String, nil] VCS type (default `nil`)
  #
  # @return [Git::RemoteInfo]
  #
  def initialize(
    name:,
    url: [],
    push_url: [],
    fetch: [],
    push: [],
    mirror: nil,
    skip_default_update: nil,
    tag_opt: nil,
    prune: nil,
    prune_tags: nil,
    receivepack: nil,
    uploadpack: nil,
    promisor: nil,
    partial_clone_filter: nil,
    vcs: nil
  )
    super(
      name:, url: Array(url), push_url: Array(push_url), fetch: Array(fetch),
      push: Array(push), mirror:, skip_default_update:, tag_opt:, prune:,
      prune_tags:, receivepack:, uploadpack:, promisor:, partial_clone_filter:,
      vcs:
    )
  end
end

#push_url ⇒ Array<String> (readonly)

Returns the push URL(s) for this remote (remote.<name>.pushurl).

Returns:

  • (Array<String>) —

    the push URL(s) for this remote (remote.<name>.pushurl)



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/git/remote_info.rb', line 70

RemoteInfo = Data.define(
  :name,
  :url,
  :push_url,
  :fetch,
  :push,
  :mirror,
  :skip_default_update,
  :tag_opt,
  :prune,
  :prune_tags,
  :receivepack,
  :uploadpack,
  :promisor,
  :partial_clone_filter,
  :vcs
) do
  # Create a new RemoteInfo
  #
  # @param name [String] the name of the remote (required)
  #
  # @param url [Array<String>] fetch URLs (default `[]`)
  #
  # @param push_url [Array<String>] push URLs (default `[]`)
  #
  # @param fetch [Array<String>] fetch refspecs (default `[]`)
  #
  # @param push [Array<String>] push refspecs (default `[]`)
  #
  # @param mirror [Boolean, nil] mirror flag (default `nil`)
  #
  # @param skip_default_update [Boolean, nil] skip-default-update flag (default `nil`)
  #
  # @param tag_opt [String, nil] tag-fetching option (default `nil`)
  #
  # @param prune [Boolean, nil] prune flag (default `nil`)
  #
  # @param prune_tags [Boolean, nil] prune-tags flag (default `nil`)
  #
  # @param receivepack [String, nil] receive-pack path (default `nil`)
  #
  # @param uploadpack [String, nil] upload-pack path (default `nil`)
  #
  # @param promisor [Boolean, nil] promisor flag (default `nil`)
  #
  # @param partial_clone_filter [String, nil] partial-clone filter (default `nil`)
  #
  # @param vcs [String, nil] VCS type (default `nil`)
  #
  # @return [Git::RemoteInfo]
  #
  def initialize(
    name:,
    url: [],
    push_url: [],
    fetch: [],
    push: [],
    mirror: nil,
    skip_default_update: nil,
    tag_opt: nil,
    prune: nil,
    prune_tags: nil,
    receivepack: nil,
    uploadpack: nil,
    promisor: nil,
    partial_clone_filter: nil,
    vcs: nil
  )
    super(
      name:, url: Array(url), push_url: Array(push_url), fetch: Array(fetch),
      push: Array(push), mirror:, skip_default_update:, tag_opt:, prune:,
      prune_tags:, receivepack:, uploadpack:, promisor:, partial_clone_filter:,
      vcs:
    )
  end
end

#receivepack ⇒ String? (readonly)

Returns the git-receive-pack path on the remote (remote.<name>.receivepack).

Returns:

  • (String, nil) —

    the git-receive-pack path on the remote (remote.<name>.receivepack)



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/git/remote_info.rb', line 70

RemoteInfo = Data.define(
  :name,
  :url,
  :push_url,
  :fetch,
  :push,
  :mirror,
  :skip_default_update,
  :tag_opt,
  :prune,
  :prune_tags,
  :receivepack,
  :uploadpack,
  :promisor,
  :partial_clone_filter,
  :vcs
) do
  # Create a new RemoteInfo
  #
  # @param name [String] the name of the remote (required)
  #
  # @param url [Array<String>] fetch URLs (default `[]`)
  #
  # @param push_url [Array<String>] push URLs (default `[]`)
  #
  # @param fetch [Array<String>] fetch refspecs (default `[]`)
  #
  # @param push [Array<String>] push refspecs (default `[]`)
  #
  # @param mirror [Boolean, nil] mirror flag (default `nil`)
  #
  # @param skip_default_update [Boolean, nil] skip-default-update flag (default `nil`)
  #
  # @param tag_opt [String, nil] tag-fetching option (default `nil`)
  #
  # @param prune [Boolean, nil] prune flag (default `nil`)
  #
  # @param prune_tags [Boolean, nil] prune-tags flag (default `nil`)
  #
  # @param receivepack [String, nil] receive-pack path (default `nil`)
  #
  # @param uploadpack [String, nil] upload-pack path (default `nil`)
  #
  # @param promisor [Boolean, nil] promisor flag (default `nil`)
  #
  # @param partial_clone_filter [String, nil] partial-clone filter (default `nil`)
  #
  # @param vcs [String, nil] VCS type (default `nil`)
  #
  # @return [Git::RemoteInfo]
  #
  def initialize(
    name:,
    url: [],
    push_url: [],
    fetch: [],
    push: [],
    mirror: nil,
    skip_default_update: nil,
    tag_opt: nil,
    prune: nil,
    prune_tags: nil,
    receivepack: nil,
    uploadpack: nil,
    promisor: nil,
    partial_clone_filter: nil,
    vcs: nil
  )
    super(
      name:, url: Array(url), push_url: Array(push_url), fetch: Array(fetch),
      push: Array(push), mirror:, skip_default_update:, tag_opt:, prune:,
      prune_tags:, receivepack:, uploadpack:, promisor:, partial_clone_filter:,
      vcs:
    )
  end
end

#skip_default_update ⇒ Boolean? (readonly)

Returns true/false per remote.<name>.skipDefaultUpdate, or nil when not set.

Returns:

  • (Boolean, nil) —

    true/false per remote.<name>.skipDefaultUpdate, or nil when not set



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/git/remote_info.rb', line 70

RemoteInfo = Data.define(
  :name,
  :url,
  :push_url,
  :fetch,
  :push,
  :mirror,
  :skip_default_update,
  :tag_opt,
  :prune,
  :prune_tags,
  :receivepack,
  :uploadpack,
  :promisor,
  :partial_clone_filter,
  :vcs
) do
  # Create a new RemoteInfo
  #
  # @param name [String] the name of the remote (required)
  #
  # @param url [Array<String>] fetch URLs (default `[]`)
  #
  # @param push_url [Array<String>] push URLs (default `[]`)
  #
  # @param fetch [Array<String>] fetch refspecs (default `[]`)
  #
  # @param push [Array<String>] push refspecs (default `[]`)
  #
  # @param mirror [Boolean, nil] mirror flag (default `nil`)
  #
  # @param skip_default_update [Boolean, nil] skip-default-update flag (default `nil`)
  #
  # @param tag_opt [String, nil] tag-fetching option (default `nil`)
  #
  # @param prune [Boolean, nil] prune flag (default `nil`)
  #
  # @param prune_tags [Boolean, nil] prune-tags flag (default `nil`)
  #
  # @param receivepack [String, nil] receive-pack path (default `nil`)
  #
  # @param uploadpack [String, nil] upload-pack path (default `nil`)
  #
  # @param promisor [Boolean, nil] promisor flag (default `nil`)
  #
  # @param partial_clone_filter [String, nil] partial-clone filter (default `nil`)
  #
  # @param vcs [String, nil] VCS type (default `nil`)
  #
  # @return [Git::RemoteInfo]
  #
  def initialize(
    name:,
    url: [],
    push_url: [],
    fetch: [],
    push: [],
    mirror: nil,
    skip_default_update: nil,
    tag_opt: nil,
    prune: nil,
    prune_tags: nil,
    receivepack: nil,
    uploadpack: nil,
    promisor: nil,
    partial_clone_filter: nil,
    vcs: nil
  )
    super(
      name:, url: Array(url), push_url: Array(push_url), fetch: Array(fetch),
      push: Array(push), mirror:, skip_default_update:, tag_opt:, prune:,
      prune_tags:, receivepack:, uploadpack:, promisor:, partial_clone_filter:,
      vcs:
    )
  end
end

#tag_opt ⇒ String? (readonly)

Returns the tag-fetching option (remote.<name>.tagOpt), or nil when not set.

Returns:

  • (String, nil) —

    the tag-fetching option (remote.<name>.tagOpt), or nil when not set



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/git/remote_info.rb', line 70

RemoteInfo = Data.define(
  :name,
  :url,
  :push_url,
  :fetch,
  :push,
  :mirror,
  :skip_default_update,
  :tag_opt,
  :prune,
  :prune_tags,
  :receivepack,
  :uploadpack,
  :promisor,
  :partial_clone_filter,
  :vcs
) do
  # Create a new RemoteInfo
  #
  # @param name [String] the name of the remote (required)
  #
  # @param url [Array<String>] fetch URLs (default `[]`)
  #
  # @param push_url [Array<String>] push URLs (default `[]`)
  #
  # @param fetch [Array<String>] fetch refspecs (default `[]`)
  #
  # @param push [Array<String>] push refspecs (default `[]`)
  #
  # @param mirror [Boolean, nil] mirror flag (default `nil`)
  #
  # @param skip_default_update [Boolean, nil] skip-default-update flag (default `nil`)
  #
  # @param tag_opt [String, nil] tag-fetching option (default `nil`)
  #
  # @param prune [Boolean, nil] prune flag (default `nil`)
  #
  # @param prune_tags [Boolean, nil] prune-tags flag (default `nil`)
  #
  # @param receivepack [String, nil] receive-pack path (default `nil`)
  #
  # @param uploadpack [String, nil] upload-pack path (default `nil`)
  #
  # @param promisor [Boolean, nil] promisor flag (default `nil`)
  #
  # @param partial_clone_filter [String, nil] partial-clone filter (default `nil`)
  #
  # @param vcs [String, nil] VCS type (default `nil`)
  #
  # @return [Git::RemoteInfo]
  #
  def initialize(
    name:,
    url: [],
    push_url: [],
    fetch: [],
    push: [],
    mirror: nil,
    skip_default_update: nil,
    tag_opt: nil,
    prune: nil,
    prune_tags: nil,
    receivepack: nil,
    uploadpack: nil,
    promisor: nil,
    partial_clone_filter: nil,
    vcs: nil
  )
    super(
      name:, url: Array(url), push_url: Array(push_url), fetch: Array(fetch),
      push: Array(push), mirror:, skip_default_update:, tag_opt:, prune:,
      prune_tags:, receivepack:, uploadpack:, promisor:, partial_clone_filter:,
      vcs:
    )
  end
end

#uploadpack ⇒ String? (readonly)

Returns the git-upload-pack path on the remote (remote.<name>.uploadpack).

Returns:

  • (String, nil) —

    the git-upload-pack path on the remote (remote.<name>.uploadpack)



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/git/remote_info.rb', line 70

RemoteInfo = Data.define(
  :name,
  :url,
  :push_url,
  :fetch,
  :push,
  :mirror,
  :skip_default_update,
  :tag_opt,
  :prune,
  :prune_tags,
  :receivepack,
  :uploadpack,
  :promisor,
  :partial_clone_filter,
  :vcs
) do
  # Create a new RemoteInfo
  #
  # @param name [String] the name of the remote (required)
  #
  # @param url [Array<String>] fetch URLs (default `[]`)
  #
  # @param push_url [Array<String>] push URLs (default `[]`)
  #
  # @param fetch [Array<String>] fetch refspecs (default `[]`)
  #
  # @param push [Array<String>] push refspecs (default `[]`)
  #
  # @param mirror [Boolean, nil] mirror flag (default `nil`)
  #
  # @param skip_default_update [Boolean, nil] skip-default-update flag (default `nil`)
  #
  # @param tag_opt [String, nil] tag-fetching option (default `nil`)
  #
  # @param prune [Boolean, nil] prune flag (default `nil`)
  #
  # @param prune_tags [Boolean, nil] prune-tags flag (default `nil`)
  #
  # @param receivepack [String, nil] receive-pack path (default `nil`)
  #
  # @param uploadpack [String, nil] upload-pack path (default `nil`)
  #
  # @param promisor [Boolean, nil] promisor flag (default `nil`)
  #
  # @param partial_clone_filter [String, nil] partial-clone filter (default `nil`)
  #
  # @param vcs [String, nil] VCS type (default `nil`)
  #
  # @return [Git::RemoteInfo]
  #
  def initialize(
    name:,
    url: [],
    push_url: [],
    fetch: [],
    push: [],
    mirror: nil,
    skip_default_update: nil,
    tag_opt: nil,
    prune: nil,
    prune_tags: nil,
    receivepack: nil,
    uploadpack: nil,
    promisor: nil,
    partial_clone_filter: nil,
    vcs: nil
  )
    super(
      name:, url: Array(url), push_url: Array(push_url), fetch: Array(fetch),
      push: Array(push), mirror:, skip_default_update:, tag_opt:, prune:,
      prune_tags:, receivepack:, uploadpack:, promisor:, partial_clone_filter:,
      vcs:
    )
  end
end

#url ⇒ Array<String> (readonly)

Returns the fetch URL(s) for this remote (remote.<name>.url).

Returns:

  • (Array<String>) —

    the fetch URL(s) for this remote (remote.<name>.url)



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/git/remote_info.rb', line 70

RemoteInfo = Data.define(
  :name,
  :url,
  :push_url,
  :fetch,
  :push,
  :mirror,
  :skip_default_update,
  :tag_opt,
  :prune,
  :prune_tags,
  :receivepack,
  :uploadpack,
  :promisor,
  :partial_clone_filter,
  :vcs
) do
  # Create a new RemoteInfo
  #
  # @param name [String] the name of the remote (required)
  #
  # @param url [Array<String>] fetch URLs (default `[]`)
  #
  # @param push_url [Array<String>] push URLs (default `[]`)
  #
  # @param fetch [Array<String>] fetch refspecs (default `[]`)
  #
  # @param push [Array<String>] push refspecs (default `[]`)
  #
  # @param mirror [Boolean, nil] mirror flag (default `nil`)
  #
  # @param skip_default_update [Boolean, nil] skip-default-update flag (default `nil`)
  #
  # @param tag_opt [String, nil] tag-fetching option (default `nil`)
  #
  # @param prune [Boolean, nil] prune flag (default `nil`)
  #
  # @param prune_tags [Boolean, nil] prune-tags flag (default `nil`)
  #
  # @param receivepack [String, nil] receive-pack path (default `nil`)
  #
  # @param uploadpack [String, nil] upload-pack path (default `nil`)
  #
  # @param promisor [Boolean, nil] promisor flag (default `nil`)
  #
  # @param partial_clone_filter [String, nil] partial-clone filter (default `nil`)
  #
  # @param vcs [String, nil] VCS type (default `nil`)
  #
  # @return [Git::RemoteInfo]
  #
  def initialize(
    name:,
    url: [],
    push_url: [],
    fetch: [],
    push: [],
    mirror: nil,
    skip_default_update: nil,
    tag_opt: nil,
    prune: nil,
    prune_tags: nil,
    receivepack: nil,
    uploadpack: nil,
    promisor: nil,
    partial_clone_filter: nil,
    vcs: nil
  )
    super(
      name:, url: Array(url), push_url: Array(push_url), fetch: Array(fetch),
      push: Array(push), mirror:, skip_default_update:, tag_opt:, prune:,
      prune_tags:, receivepack:, uploadpack:, promisor:, partial_clone_filter:,
      vcs:
    )
  end
end

#vcs ⇒ String? (readonly)

Returns the VCS type for git-remote helpers (remote.<name>.vcs).

Returns:

  • (String, nil) —

    the VCS type for git-remote helpers (remote.<name>.vcs)



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/git/remote_info.rb', line 70

RemoteInfo = Data.define(
  :name,
  :url,
  :push_url,
  :fetch,
  :push,
  :mirror,
  :skip_default_update,
  :tag_opt,
  :prune,
  :prune_tags,
  :receivepack,
  :uploadpack,
  :promisor,
  :partial_clone_filter,
  :vcs
) do
  # Create a new RemoteInfo
  #
  # @param name [String] the name of the remote (required)
  #
  # @param url [Array<String>] fetch URLs (default `[]`)
  #
  # @param push_url [Array<String>] push URLs (default `[]`)
  #
  # @param fetch [Array<String>] fetch refspecs (default `[]`)
  #
  # @param push [Array<String>] push refspecs (default `[]`)
  #
  # @param mirror [Boolean, nil] mirror flag (default `nil`)
  #
  # @param skip_default_update [Boolean, nil] skip-default-update flag (default `nil`)
  #
  # @param tag_opt [String, nil] tag-fetching option (default `nil`)
  #
  # @param prune [Boolean, nil] prune flag (default `nil`)
  #
  # @param prune_tags [Boolean, nil] prune-tags flag (default `nil`)
  #
  # @param receivepack [String, nil] receive-pack path (default `nil`)
  #
  # @param uploadpack [String, nil] upload-pack path (default `nil`)
  #
  # @param promisor [Boolean, nil] promisor flag (default `nil`)
  #
  # @param partial_clone_filter [String, nil] partial-clone filter (default `nil`)
  #
  # @param vcs [String, nil] VCS type (default `nil`)
  #
  # @return [Git::RemoteInfo]
  #
  def initialize(
    name:,
    url: [],
    push_url: [],
    fetch: [],
    push: [],
    mirror: nil,
    skip_default_update: nil,
    tag_opt: nil,
    prune: nil,
    prune_tags: nil,
    receivepack: nil,
    uploadpack: nil,
    promisor: nil,
    partial_clone_filter: nil,
    vcs: nil
  )
    super(
      name:, url: Array(url), push_url: Array(push_url), fetch: Array(fetch),
      push: Array(push), mirror:, skip_default_update:, tag_opt:, prune:,
      prune_tags:, receivepack:, uploadpack:, promisor:, partial_clone_filter:,
      vcs:
    )
  end
end