nerdbank-gitversioning 3.5.113 → 3.6.65-alpha
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/nbgv.cli/tools/netcoreapp3.1/any/LibGit2Sharp.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/Nerdbank.GitVersioning.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/Nerdbank.GitVersioning.pdb +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/{NerdBank.GitVersioning.xml → Nerdbank.GitVersioning.xml} +1053 -664
- package/nbgv.cli/tools/netcoreapp3.1/any/NuGet.Commands.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/NuGet.Common.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/NuGet.Configuration.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/NuGet.Credentials.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/NuGet.DependencyResolver.Core.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/NuGet.Frameworks.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/NuGet.LibraryModel.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/NuGet.PackageManagement.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/NuGet.Packaging.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/NuGet.ProjectModel.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/NuGet.Protocol.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/NuGet.Resolver.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/NuGet.Versioning.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/System.CommandLine.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/cs/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/de/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/es/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/fr/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/it/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/ja/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/ko/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/nbgv.deps.json +432 -148
- package/nbgv.cli/tools/netcoreapp3.1/any/nbgv.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/nbgv.exe +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/nbgv.xml +11 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/pl/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/pt-BR/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/ru/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/tr/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/zh-Hans/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/zh-Hant/System.CommandLine.resources.dll +0 -0
- package/package.json +3 -3
- package/nbgv.cli/tools/netcoreapp3.1/any/NerdBank.GitVersioning.dll +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/NerdBank.GitVersioning.pdb +0 -0
- package/nbgv.cli/tools/netcoreapp3.1/any/nbgv.pdb +0 -0
package/nbgv.cli/tools/netcoreapp3.1/any/{NerdBank.GitVersioning.xml → Nerdbank.GitVersioning.xml}
RENAMED
|
@@ -1,9 +1,18 @@
|
|
|
1
1
|
<?xml version="1.0"?>
|
|
2
2
|
<doc>
|
|
3
3
|
<assembly>
|
|
4
|
-
<name>
|
|
4
|
+
<name>Nerdbank.GitVersioning</name>
|
|
5
5
|
</assembly>
|
|
6
6
|
<members>
|
|
7
|
+
<member name="M:Nerdbank.GitVersioning.AssemblyVersionOptionsConverter.CanConvert(System.Type)">
|
|
8
|
+
<inheritdoc/>
|
|
9
|
+
</member>
|
|
10
|
+
<member name="M:Nerdbank.GitVersioning.AssemblyVersionOptionsConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
|
|
11
|
+
<inheritdoc/>
|
|
12
|
+
</member>
|
|
13
|
+
<member name="M:Nerdbank.GitVersioning.AssemblyVersionOptionsConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
|
|
14
|
+
<inheritdoc/>
|
|
15
|
+
</member>
|
|
7
16
|
<member name="T:Nerdbank.GitVersioning.CloudBuild">
|
|
8
17
|
<summary>
|
|
9
18
|
Provides access to cloud build providers.
|
|
@@ -23,8 +32,8 @@
|
|
|
23
32
|
<summary>
|
|
24
33
|
Gets the specified string, prefixing it with some value if it is non-empty and lacks the prefix.
|
|
25
34
|
</summary>
|
|
26
|
-
<param name="prefix">The prefix that should be included in the returned value.</param>
|
|
27
35
|
<param name="value">The value to prefix.</param>
|
|
36
|
+
<param name="prefix">The prefix that should be included in the returned value.</param>
|
|
28
37
|
<returns>The <paramref name="value" /> provided, with <paramref name="prefix" /> prepended
|
|
29
38
|
if the value doesn't already start with that string and the value is non-empty.</returns>
|
|
30
39
|
</member>
|
|
@@ -34,94 +43,318 @@
|
|
|
34
43
|
</summary>
|
|
35
44
|
<param name="value">The value to return.</param>
|
|
36
45
|
<param name="prefix">The prefix to check for.</param>
|
|
37
|
-
<returns><paramref name="value"/> if it starts with <paramref name="prefix"/>; otherwise <
|
|
46
|
+
<returns><paramref name="value"/> if it starts with <paramref name="prefix"/>; otherwise <see langword="null"/>.</returns>
|
|
38
47
|
</member>
|
|
39
48
|
<member name="T:Nerdbank.GitVersioning.CloudBuildServices.AppVeyor">
|
|
40
49
|
<summary>
|
|
41
|
-
|
|
50
|
+
Cloud build handling for AppVeyor.
|
|
42
51
|
</summary>
|
|
43
52
|
<remarks>
|
|
44
|
-
The AppVeyor-specific properties referenced here are documented here
|
|
45
|
-
http://www.appveyor.com/docs/environment-variables
|
|
53
|
+
The AppVeyor-specific properties referenced here are <see href="http://www.appveyor.com/docs/environment-variables">documented here</see>.
|
|
46
54
|
</remarks>
|
|
47
55
|
</member>
|
|
48
56
|
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.AppVeyor.BuildingBranch">
|
|
49
|
-
<
|
|
50
|
-
|
|
51
|
-
</summary>
|
|
57
|
+
<inheritdoc/>
|
|
52
58
|
<remarks>
|
|
53
|
-
AppVeyor's branch variable is the target branch of a PR, which is *NOT* to be misinterpreted
|
|
59
|
+
AppVeyor's branch variable is the target branch of a PR, which is *NOT* to be misinterpreted
|
|
54
60
|
as building the target branch itself. So only set the branch built property if it's not a PR.
|
|
55
61
|
</remarks>
|
|
56
62
|
</member>
|
|
63
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.AppVeyor.BuildingTag">
|
|
64
|
+
<inheritdoc/>
|
|
65
|
+
</member>
|
|
66
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.AppVeyor.GitCommitId">
|
|
67
|
+
<inheritdoc/>
|
|
68
|
+
</member>
|
|
69
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.AppVeyor.IsApplicable">
|
|
70
|
+
<inheritdoc/>
|
|
71
|
+
</member>
|
|
72
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.AppVeyor.IsPullRequest">
|
|
73
|
+
<inheritdoc/>
|
|
74
|
+
</member>
|
|
75
|
+
<member name="M:Nerdbank.GitVersioning.CloudBuildServices.AppVeyor.SetCloudBuildNumber(System.String,System.IO.TextWriter,System.IO.TextWriter)">
|
|
76
|
+
<inheritdoc/>
|
|
77
|
+
</member>
|
|
78
|
+
<member name="M:Nerdbank.GitVersioning.CloudBuildServices.AppVeyor.SetCloudBuildVariable(System.String,System.String,System.IO.TextWriter,System.IO.TextWriter)">
|
|
79
|
+
<inheritdoc/>
|
|
80
|
+
</member>
|
|
57
81
|
<member name="T:Nerdbank.GitVersioning.CloudBuildServices.AtlassianBamboo">
|
|
58
82
|
<summary>
|
|
59
|
-
|
|
83
|
+
Cloud build handling for Atlassian Bamboo.
|
|
84
|
+
</summary>
|
|
85
|
+
<remarks>
|
|
86
|
+
The Bamboo-specific properties referenced here are <see href="https://confluence.atlassian.com/bamboo/bamboo-variables-289277087.html">documented here</see>.
|
|
87
|
+
</remarks>
|
|
88
|
+
</member>
|
|
89
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.AtlassianBamboo.IsPullRequest">
|
|
90
|
+
<inheritdoc/>
|
|
91
|
+
</member>
|
|
92
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.AtlassianBamboo.BuildingTag">
|
|
93
|
+
<inheritdoc/>
|
|
94
|
+
</member>
|
|
95
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.AtlassianBamboo.BuildingBranch">
|
|
96
|
+
<inheritdoc/>
|
|
97
|
+
</member>
|
|
98
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.AtlassianBamboo.GitCommitId">
|
|
99
|
+
<inheritdoc/>
|
|
100
|
+
</member>
|
|
101
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.AtlassianBamboo.IsApplicable">
|
|
102
|
+
<inheritdoc/>
|
|
103
|
+
</member>
|
|
104
|
+
<member name="M:Nerdbank.GitVersioning.CloudBuildServices.AtlassianBamboo.SetCloudBuildNumber(System.String,System.IO.TextWriter,System.IO.TextWriter)">
|
|
105
|
+
<inheritdoc/>
|
|
106
|
+
</member>
|
|
107
|
+
<member name="M:Nerdbank.GitVersioning.CloudBuildServices.AtlassianBamboo.SetCloudBuildVariable(System.String,System.String,System.IO.TextWriter,System.IO.TextWriter)">
|
|
108
|
+
<inheritdoc/>
|
|
109
|
+
</member>
|
|
110
|
+
<member name="T:Nerdbank.GitVersioning.CloudBuildServices.BitbucketCloud">
|
|
111
|
+
<summary>
|
|
112
|
+
Cloud build handling for Bitbucket Cloud.
|
|
113
|
+
</summary>
|
|
114
|
+
<remarks>
|
|
115
|
+
The Bitbucket-specific properties referenced here are <see href="https://support.atlassian.com/bitbucket-cloud/docs/variables-and-secrets/">documented here</see>.
|
|
116
|
+
</remarks>
|
|
117
|
+
</member>
|
|
118
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.BitbucketCloud.IsApplicable">
|
|
119
|
+
<inheritdoc />
|
|
120
|
+
</member>
|
|
121
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.BitbucketCloud.IsPullRequest">
|
|
122
|
+
<inheritdoc />
|
|
123
|
+
</member>
|
|
124
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.BitbucketCloud.BuildingBranch">
|
|
125
|
+
<inheritdoc />
|
|
126
|
+
</member>
|
|
127
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.BitbucketCloud.BuildingTag">
|
|
128
|
+
<inheritdoc />
|
|
129
|
+
</member>
|
|
130
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.BitbucketCloud.GitCommitId">
|
|
131
|
+
<inheritdoc />
|
|
132
|
+
</member>
|
|
133
|
+
<member name="M:Nerdbank.GitVersioning.CloudBuildServices.BitbucketCloud.SetCloudBuildNumber(System.String,System.IO.TextWriter,System.IO.TextWriter)">
|
|
134
|
+
<inheritdoc />
|
|
135
|
+
</member>
|
|
136
|
+
<member name="M:Nerdbank.GitVersioning.CloudBuildServices.BitbucketCloud.SetCloudBuildVariable(System.String,System.String,System.IO.TextWriter,System.IO.TextWriter)">
|
|
137
|
+
<inheritdoc />
|
|
138
|
+
</member>
|
|
139
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.GitHubActions.IsApplicable">
|
|
140
|
+
<inheritdoc/>
|
|
141
|
+
</member>
|
|
142
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.GitHubActions.IsPullRequest">
|
|
143
|
+
<inheritdoc/>
|
|
144
|
+
</member>
|
|
145
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.GitHubActions.BuildingBranch">
|
|
146
|
+
<inheritdoc/>
|
|
147
|
+
</member>
|
|
148
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.GitHubActions.BuildingTag">
|
|
149
|
+
<inheritdoc/>
|
|
150
|
+
</member>
|
|
151
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.GitHubActions.GitCommitId">
|
|
152
|
+
<inheritdoc/>
|
|
153
|
+
</member>
|
|
154
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.GitHubActions.IgnoreGitHubRef">
|
|
155
|
+
<summary>
|
|
156
|
+
Gets a value indicating whether to ignore GitHub Actions environment variables that indicate where HEAD is.
|
|
60
157
|
</summary>
|
|
61
158
|
<remarks>
|
|
62
|
-
|
|
63
|
-
|
|
159
|
+
This is useful in a GitHub workflow where HEAD was moved by some prior Action, such that the environment variables are stale.
|
|
160
|
+
GitHub Actions does not allow these env vars to be changed mid-workflow, so in such cases NB.GV should just use HEAD.
|
|
64
161
|
</remarks>
|
|
65
162
|
</member>
|
|
163
|
+
<member name="M:Nerdbank.GitVersioning.CloudBuildServices.GitHubActions.SetCloudBuildNumber(System.String,System.IO.TextWriter,System.IO.TextWriter)">
|
|
164
|
+
<inheritdoc/>
|
|
165
|
+
</member>
|
|
166
|
+
<member name="M:Nerdbank.GitVersioning.CloudBuildServices.GitHubActions.SetCloudBuildVariable(System.String,System.String,System.IO.TextWriter,System.IO.TextWriter)">
|
|
167
|
+
<inheritdoc/>
|
|
168
|
+
</member>
|
|
66
169
|
<member name="T:Nerdbank.GitVersioning.CloudBuildServices.GitLab">
|
|
67
170
|
<summary>
|
|
68
|
-
|
|
171
|
+
Cloud build handling for GitLab.
|
|
69
172
|
</summary>
|
|
70
173
|
<remarks>
|
|
71
|
-
The GitLab-specific properties referenced here are documented here
|
|
72
|
-
https://docs.gitlab.com/ce/ci/variables/README.html
|
|
174
|
+
The GitLab-specific properties referenced here are <see href="https://docs.gitlab.com/ce/ci/variables/README.html">documented here</see>.
|
|
73
175
|
</remarks>
|
|
74
176
|
</member>
|
|
177
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.GitLab.BuildingBranch">
|
|
178
|
+
<inheritdoc/>
|
|
179
|
+
</member>
|
|
180
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.GitLab.BuildingTag">
|
|
181
|
+
<inheritdoc/>
|
|
182
|
+
</member>
|
|
183
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.GitLab.GitCommitId">
|
|
184
|
+
<inheritdoc/>
|
|
185
|
+
</member>
|
|
186
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.GitLab.IsApplicable">
|
|
187
|
+
<inheritdoc/>
|
|
188
|
+
</member>
|
|
189
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.GitLab.IsPullRequest">
|
|
190
|
+
<inheritdoc/>
|
|
191
|
+
</member>
|
|
192
|
+
<member name="M:Nerdbank.GitVersioning.CloudBuildServices.GitLab.SetCloudBuildNumber(System.String,System.IO.TextWriter,System.IO.TextWriter)">
|
|
193
|
+
<inheritdoc/>
|
|
194
|
+
</member>
|
|
195
|
+
<member name="M:Nerdbank.GitVersioning.CloudBuildServices.GitLab.SetCloudBuildVariable(System.String,System.String,System.IO.TextWriter,System.IO.TextWriter)">
|
|
196
|
+
<inheritdoc/>
|
|
197
|
+
</member>
|
|
75
198
|
<member name="T:Nerdbank.GitVersioning.CloudBuildServices.Jenkins">
|
|
199
|
+
<summary>
|
|
200
|
+
Cloud build handling for Jenkins.
|
|
201
|
+
</summary>
|
|
76
202
|
<remarks>
|
|
77
|
-
The Jenkins-specific properties referenced here are documented here
|
|
78
|
-
https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin#GitPlugin-Environmentvariables
|
|
203
|
+
The Jenkins-specific properties referenced here are <see href="https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin#GitPlugin-Environmentvariables">documented here</see>.
|
|
79
204
|
</remarks>
|
|
80
205
|
</member>
|
|
206
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.Jenkins.BuildingTag">
|
|
207
|
+
<inheritdoc/>
|
|
208
|
+
</member>
|
|
209
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.Jenkins.IsPullRequest">
|
|
210
|
+
<inheritdoc/>
|
|
211
|
+
</member>
|
|
212
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.Jenkins.BuildingBranch">
|
|
213
|
+
<inheritdoc/>
|
|
214
|
+
</member>
|
|
215
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.Jenkins.GitCommitId">
|
|
216
|
+
<inheritdoc/>
|
|
217
|
+
</member>
|
|
218
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.Jenkins.IsApplicable">
|
|
219
|
+
<inheritdoc/>
|
|
220
|
+
</member>
|
|
221
|
+
<member name="M:Nerdbank.GitVersioning.CloudBuildServices.Jenkins.SetCloudBuildNumber(System.String,System.IO.TextWriter,System.IO.TextWriter)">
|
|
222
|
+
<inheritdoc/>
|
|
223
|
+
</member>
|
|
224
|
+
<member name="M:Nerdbank.GitVersioning.CloudBuildServices.Jenkins.SetCloudBuildVariable(System.String,System.String,System.IO.TextWriter,System.IO.TextWriter)">
|
|
225
|
+
<inheritdoc/>
|
|
226
|
+
</member>
|
|
81
227
|
<member name="T:Nerdbank.GitVersioning.CloudBuildServices.SpaceAutomation">
|
|
82
228
|
<summary>
|
|
83
229
|
SpaceAutomation CI build support.
|
|
84
230
|
</summary>
|
|
85
231
|
<remarks>
|
|
86
|
-
The SpaceAutomation-specific properties referenced here are documented here
|
|
87
|
-
https://www.jetbrains.com/help/space/automation-environment-variables.html
|
|
232
|
+
The SpaceAutomation-specific properties referenced here are <see href="https://www.jetbrains.com/help/space/automation-environment-variables.html">documented here</see>.
|
|
88
233
|
</remarks>
|
|
89
234
|
</member>
|
|
235
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.SpaceAutomation.BuildingBranch">
|
|
236
|
+
<inheritdoc/>
|
|
237
|
+
</member>
|
|
238
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.SpaceAutomation.BuildingTag">
|
|
239
|
+
<inheritdoc/>
|
|
240
|
+
</member>
|
|
241
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.SpaceAutomation.GitCommitId">
|
|
242
|
+
<inheritdoc/>
|
|
243
|
+
</member>
|
|
244
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.SpaceAutomation.IsApplicable">
|
|
245
|
+
<inheritdoc/>
|
|
246
|
+
</member>
|
|
247
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.SpaceAutomation.IsPullRequest">
|
|
248
|
+
<inheritdoc/>
|
|
249
|
+
</member>
|
|
250
|
+
<member name="M:Nerdbank.GitVersioning.CloudBuildServices.SpaceAutomation.SetCloudBuildNumber(System.String,System.IO.TextWriter,System.IO.TextWriter)">
|
|
251
|
+
<inheritdoc/>
|
|
252
|
+
</member>
|
|
253
|
+
<member name="M:Nerdbank.GitVersioning.CloudBuildServices.SpaceAutomation.SetCloudBuildVariable(System.String,System.String,System.IO.TextWriter,System.IO.TextWriter)">
|
|
254
|
+
<inheritdoc/>
|
|
255
|
+
</member>
|
|
90
256
|
<member name="T:Nerdbank.GitVersioning.CloudBuildServices.TeamCity">
|
|
91
257
|
<summary>
|
|
92
258
|
TeamCity CI build support.
|
|
93
259
|
</summary>
|
|
94
260
|
<remarks>
|
|
95
|
-
The TeamCity-specific properties referenced here are documented here
|
|
96
|
-
https://www.jetbrains.com/help/teamcity/predefined-build-parameters.html
|
|
261
|
+
The TeamCity-specific properties referenced here are <see href="https://www.jetbrains.com/help/teamcity/predefined-build-parameters.html">documented here</see>.
|
|
97
262
|
</remarks>
|
|
98
263
|
</member>
|
|
264
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.TeamCity.BuildingBranch">
|
|
265
|
+
<inheritdoc/>
|
|
266
|
+
</member>
|
|
267
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.TeamCity.BuildingTag">
|
|
268
|
+
<inheritdoc/>
|
|
269
|
+
</member>
|
|
270
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.TeamCity.GitCommitId">
|
|
271
|
+
<inheritdoc/>
|
|
272
|
+
</member>
|
|
273
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.TeamCity.IsApplicable">
|
|
274
|
+
<inheritdoc/>
|
|
275
|
+
</member>
|
|
276
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.TeamCity.IsPullRequest">
|
|
277
|
+
<inheritdoc/>
|
|
278
|
+
</member>
|
|
279
|
+
<member name="M:Nerdbank.GitVersioning.CloudBuildServices.TeamCity.SetCloudBuildNumber(System.String,System.IO.TextWriter,System.IO.TextWriter)">
|
|
280
|
+
<inheritdoc/>
|
|
281
|
+
</member>
|
|
282
|
+
<member name="M:Nerdbank.GitVersioning.CloudBuildServices.TeamCity.SetCloudBuildVariable(System.String,System.String,System.IO.TextWriter,System.IO.TextWriter)">
|
|
283
|
+
<inheritdoc/>
|
|
284
|
+
</member>
|
|
99
285
|
<member name="T:Nerdbank.GitVersioning.CloudBuildServices.Travis">
|
|
100
286
|
<summary>
|
|
101
287
|
Travis CI build support.
|
|
102
288
|
</summary>
|
|
103
289
|
<remarks>
|
|
104
|
-
The Travis CI environment variables referenced here are documented here
|
|
105
|
-
https://docs.travis-ci.com/user/environment-variables/#default-environment-variables
|
|
290
|
+
The Travis CI environment variables referenced here are <see href="https://docs.travis-ci.com/user/environment-variables/#default-environment-variables">documented here</see>.
|
|
106
291
|
</remarks>
|
|
107
292
|
</member>
|
|
293
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.Travis.BuildingBranch">
|
|
294
|
+
<inheritdoc/>
|
|
295
|
+
</member>
|
|
296
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.Travis.BuildingTag">
|
|
297
|
+
<inheritdoc/>
|
|
298
|
+
</member>
|
|
299
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.Travis.GitCommitId">
|
|
300
|
+
<inheritdoc/>
|
|
301
|
+
</member>
|
|
302
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.Travis.IsApplicable">
|
|
303
|
+
<inheritdoc/>
|
|
304
|
+
</member>
|
|
305
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.Travis.IsPullRequest">
|
|
306
|
+
<inheritdoc/>
|
|
307
|
+
</member>
|
|
308
|
+
<member name="M:Nerdbank.GitVersioning.CloudBuildServices.Travis.SetCloudBuildNumber(System.String,System.IO.TextWriter,System.IO.TextWriter)">
|
|
309
|
+
<inheritdoc/>
|
|
310
|
+
</member>
|
|
311
|
+
<member name="M:Nerdbank.GitVersioning.CloudBuildServices.Travis.SetCloudBuildVariable(System.String,System.String,System.IO.TextWriter,System.IO.TextWriter)">
|
|
312
|
+
<inheritdoc/>
|
|
313
|
+
</member>
|
|
108
314
|
<member name="T:Nerdbank.GitVersioning.CloudBuildServices.VisualStudioTeamServices">
|
|
109
315
|
<summary>
|
|
110
|
-
|
|
316
|
+
Cloud build handling for Azure DevOps.
|
|
111
317
|
</summary>
|
|
112
318
|
<remarks>
|
|
113
|
-
The VSTS-specific properties referenced here are documented here
|
|
114
|
-
https://msdn.microsoft.com/en-us/Library/vs/alm/Build/scripts/variables
|
|
319
|
+
The VSTS-specific properties referenced here are <see href="https://msdn.microsoft.com/en-us/Library/vs/alm/Build/scripts/variables">documented here</see>.
|
|
115
320
|
</remarks>
|
|
116
321
|
</member>
|
|
322
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.VisualStudioTeamServices.IsPullRequest">
|
|
323
|
+
<inheritdoc/>
|
|
324
|
+
</member>
|
|
325
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.VisualStudioTeamServices.BuildingTag">
|
|
326
|
+
<inheritdoc/>
|
|
327
|
+
</member>
|
|
328
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.VisualStudioTeamServices.BuildingBranch">
|
|
329
|
+
<inheritdoc/>
|
|
330
|
+
</member>
|
|
331
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.VisualStudioTeamServices.GitCommitId">
|
|
332
|
+
<inheritdoc/>
|
|
333
|
+
</member>
|
|
334
|
+
<member name="P:Nerdbank.GitVersioning.CloudBuildServices.VisualStudioTeamServices.IsApplicable">
|
|
335
|
+
<inheritdoc/>
|
|
336
|
+
</member>
|
|
337
|
+
<member name="M:Nerdbank.GitVersioning.CloudBuildServices.VisualStudioTeamServices.SetCloudBuildNumber(System.String,System.IO.TextWriter,System.IO.TextWriter)">
|
|
338
|
+
<inheritdoc/>
|
|
339
|
+
</member>
|
|
340
|
+
<member name="M:Nerdbank.GitVersioning.CloudBuildServices.VisualStudioTeamServices.SetCloudBuildVariable(System.String,System.String,System.IO.TextWriter,System.IO.TextWriter)">
|
|
341
|
+
<inheritdoc/>
|
|
342
|
+
</member>
|
|
117
343
|
<member name="T:Nerdbank.GitVersioning.Commands.CloudCommand">
|
|
118
344
|
<summary>
|
|
119
345
|
Implementation of the "nbgv cloud" command that updates the build environments variables with version variables.
|
|
120
346
|
</summary>
|
|
121
347
|
</member>
|
|
348
|
+
<member name="M:Nerdbank.GitVersioning.Commands.CloudCommand.#ctor(System.IO.TextWriter,System.IO.TextWriter)">
|
|
349
|
+
<summary>
|
|
350
|
+
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.Commands.CloudCommand"/> class.
|
|
351
|
+
</summary>
|
|
352
|
+
<param name="outputWriter">The <see cref="T:System.IO.TextWriter"/> to write output to (e.g. <see cref="P:System.Console.Out" />).</param>
|
|
353
|
+
<param name="errorWriter">The <see cref="T:System.IO.TextWriter"/> to write error messages to (e.g. <see cref="P:System.Console.Error" />).</param>
|
|
354
|
+
</member>
|
|
122
355
|
<member name="T:Nerdbank.GitVersioning.Commands.CloudCommand.CloudCommandError">
|
|
123
356
|
<summary>
|
|
124
|
-
Defines the possible errors of the "cloud" command
|
|
357
|
+
Defines the possible errors of the "cloud" command.
|
|
125
358
|
</summary>
|
|
126
359
|
</member>
|
|
127
360
|
<member name="F:Nerdbank.GitVersioning.Commands.CloudCommand.CloudCommandError.NoCloudBuildProviderMatch">
|
|
@@ -139,30 +372,6 @@
|
|
|
139
372
|
No supported cloud build environment could be detected.
|
|
140
373
|
</summary>
|
|
141
374
|
</member>
|
|
142
|
-
<member name="T:Nerdbank.GitVersioning.Commands.CloudCommand.CloudCommandException">
|
|
143
|
-
<summary>
|
|
144
|
-
Exception indicating an error while setting build variables.
|
|
145
|
-
</summary>
|
|
146
|
-
</member>
|
|
147
|
-
<member name="P:Nerdbank.GitVersioning.Commands.CloudCommand.CloudCommandException.Error">
|
|
148
|
-
<summary>
|
|
149
|
-
Gets the error that occurred.
|
|
150
|
-
</summary>
|
|
151
|
-
</member>
|
|
152
|
-
<member name="M:Nerdbank.GitVersioning.Commands.CloudCommand.CloudCommandException.#ctor(System.String,Nerdbank.GitVersioning.Commands.CloudCommand.CloudCommandError)">
|
|
153
|
-
<summary>
|
|
154
|
-
Initializes a new instance of <see cref="T:Nerdbank.GitVersioning.Commands.CloudCommand.CloudCommandException"/> class.
|
|
155
|
-
</summary>
|
|
156
|
-
<param name="message">The message that describes the error.</param>
|
|
157
|
-
<param name="error">The error that occurred.</param>
|
|
158
|
-
</member>
|
|
159
|
-
<member name="M:Nerdbank.GitVersioning.Commands.CloudCommand.#ctor(System.IO.TextWriter,System.IO.TextWriter)">
|
|
160
|
-
<summary>
|
|
161
|
-
Initializes a new instance of <see cref="T:Nerdbank.GitVersioning.Commands.CloudCommand"/>.
|
|
162
|
-
</summary>
|
|
163
|
-
<param name="outputWriter">The <see cref="T:System.IO.TextWriter"/> to write output to (e.g. <see cref="P:System.Console.Out" />).</param>
|
|
164
|
-
<param name="errorWriter">The <see cref="T:System.IO.TextWriter"/> to write error messages to (e.g. <see cref="P:System.Console.Error" />).</param>
|
|
165
|
-
</member>
|
|
166
375
|
<member name="M:Nerdbank.GitVersioning.Commands.CloudCommand.SetBuildVariables(System.String,System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.Boolean,System.Boolean,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}},System.Boolean)">
|
|
167
376
|
<summary>
|
|
168
377
|
Adds version variables to the the current cloud build environment.
|
|
@@ -193,69 +402,45 @@
|
|
|
193
402
|
Force usage of LibGit2 for accessing the git repository.
|
|
194
403
|
</param>
|
|
195
404
|
</member>
|
|
196
|
-
<member name="T:Nerdbank.GitVersioning.
|
|
197
|
-
<summary>
|
|
198
|
-
A filter (include or exclude) representing a repo relative path.
|
|
199
|
-
</summary>
|
|
200
|
-
</member>
|
|
201
|
-
<member name="P:Nerdbank.GitVersioning.FilterPath.IsExclude">
|
|
202
|
-
<summary>
|
|
203
|
-
True if this <see cref="T:Nerdbank.GitVersioning.FilterPath"/> represents an exclude filter.
|
|
204
|
-
</summary>
|
|
205
|
-
</member>
|
|
206
|
-
<member name="P:Nerdbank.GitVersioning.FilterPath.IsInclude">
|
|
207
|
-
<summary>
|
|
208
|
-
<see langword="true"/> if this <see cref="T:Nerdbank.GitVersioning.FilterPath"/> represents an include filter.
|
|
209
|
-
</summary>
|
|
210
|
-
</member>
|
|
211
|
-
<member name="P:Nerdbank.GitVersioning.FilterPath.RepoRelativePath">
|
|
405
|
+
<member name="T:Nerdbank.GitVersioning.Commands.CloudCommand.CloudCommandException">
|
|
212
406
|
<summary>
|
|
213
|
-
|
|
214
|
-
Directories are delimited with forward slashes.
|
|
407
|
+
Exception indicating an error while setting build variables.
|
|
215
408
|
</summary>
|
|
216
409
|
</member>
|
|
217
|
-
<member name="
|
|
410
|
+
<member name="M:Nerdbank.GitVersioning.Commands.CloudCommand.CloudCommandException.#ctor(System.String,Nerdbank.GitVersioning.Commands.CloudCommand.CloudCommandError)">
|
|
218
411
|
<summary>
|
|
219
|
-
|
|
412
|
+
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.Commands.CloudCommand.CloudCommandException"/> class.
|
|
220
413
|
</summary>
|
|
414
|
+
<param name="message">The message that describes the error.</param>
|
|
415
|
+
<param name="error">The error that occurred.</param>
|
|
221
416
|
</member>
|
|
222
|
-
<member name="P:Nerdbank.GitVersioning.
|
|
417
|
+
<member name="P:Nerdbank.GitVersioning.Commands.CloudCommand.CloudCommandException.Error">
|
|
223
418
|
<summary>
|
|
224
|
-
|
|
419
|
+
Gets the error that occurred.
|
|
225
420
|
</summary>
|
|
226
421
|
</member>
|
|
227
|
-
<member name="
|
|
422
|
+
<member name="T:Nerdbank.GitVersioning.FilterPath">
|
|
228
423
|
<summary>
|
|
229
|
-
|
|
424
|
+
A filter (include or exclude) representing a repo relative path.
|
|
230
425
|
</summary>
|
|
231
|
-
<param name="path">
|
|
232
|
-
See <see cref="M:Nerdbank.GitVersioning.FilterPath.#ctor(System.String,System.String)"/> for supported
|
|
233
|
-
formats of pathspecs.
|
|
234
|
-
</param>
|
|
235
|
-
<param name="relativeTo">
|
|
236
|
-
Path that <paramref name="path"/> is relative to.
|
|
237
|
-
Can be empty - which indicates <paramref name="path"/> is
|
|
238
|
-
relative to the root of the repository.
|
|
239
|
-
</param>
|
|
240
|
-
<returns>
|
|
241
|
-
Forward slash delimited string representing the root-relative path.
|
|
242
|
-
</returns>
|
|
243
426
|
</member>
|
|
244
427
|
<member name="M:Nerdbank.GitVersioning.FilterPath.#ctor(System.String,System.String)">
|
|
245
428
|
<summary>
|
|
246
|
-
|
|
247
|
-
relative path within the repository.
|
|
429
|
+
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.FilterPath"/> class
|
|
430
|
+
from a pathspec-like string and a relative path within the repository.
|
|
248
431
|
</summary>
|
|
249
432
|
<param name="pathSpec">
|
|
250
433
|
A string that supports some pathspec features.
|
|
251
434
|
This path is relative to <paramref name="relativeTo"/>.
|
|
252
435
|
|
|
253
436
|
Examples:
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
437
|
+
<list type="bullet">
|
|
438
|
+
<item><c>../relative/inclusion.txt</c></item>
|
|
439
|
+
<item><c>:/absolute/inclusion.txt</c></item>
|
|
440
|
+
<item><c>:!relative/exclusion.txt</c></item>
|
|
441
|
+
<item><c>:^relative/exclusion.txt</c></item>
|
|
442
|
+
<item><c>:^/absolute/exclusion.txt</c></item>
|
|
443
|
+
</list>
|
|
259
444
|
</param>
|
|
260
445
|
<param name="relativeTo">
|
|
261
446
|
Path (relative to the root of the repository) that <paramref name="pathSpec"/> is relative to.
|
|
@@ -264,6 +449,32 @@
|
|
|
264
449
|
</param>
|
|
265
450
|
<exception cref="T:System.FormatException">Invalid path spec.</exception>
|
|
266
451
|
</member>
|
|
452
|
+
<member name="P:Nerdbank.GitVersioning.FilterPath.IsExclude">
|
|
453
|
+
<summary>
|
|
454
|
+
Gets a value indicating whether <see cref="T:Nerdbank.GitVersioning.FilterPath"/> represents an exclude filter.
|
|
455
|
+
</summary>
|
|
456
|
+
</member>
|
|
457
|
+
<member name="P:Nerdbank.GitVersioning.FilterPath.IsInclude">
|
|
458
|
+
<summary>
|
|
459
|
+
Gets a value indicating whether <see cref="T:Nerdbank.GitVersioning.FilterPath"/> represents an include filter.
|
|
460
|
+
</summary>
|
|
461
|
+
</member>
|
|
462
|
+
<member name="P:Nerdbank.GitVersioning.FilterPath.RepoRelativePath">
|
|
463
|
+
<summary>
|
|
464
|
+
Gets the path that this <see cref="T:Nerdbank.GitVersioning.FilterPath"/> represents, relative to the repository root.
|
|
465
|
+
Directories are delimited with forward slashes.
|
|
466
|
+
</summary>
|
|
467
|
+
</member>
|
|
468
|
+
<member name="P:Nerdbank.GitVersioning.FilterPath.IsRoot">
|
|
469
|
+
<summary>
|
|
470
|
+
Gets a value indicating whether <see cref="T:Nerdbank.GitVersioning.FilterPath"/> represents the root of the repository.
|
|
471
|
+
</summary>
|
|
472
|
+
</member>
|
|
473
|
+
<member name="P:Nerdbank.GitVersioning.FilterPath.IsRelative">
|
|
474
|
+
<summary>
|
|
475
|
+
Gets a value indicating whether the original pathspec was parsed as a relative path.
|
|
476
|
+
</summary>
|
|
477
|
+
</member>
|
|
267
478
|
<member name="M:Nerdbank.GitVersioning.FilterPath.Excludes(System.String,System.Boolean)">
|
|
268
479
|
<summary>
|
|
269
480
|
Determines if <paramref name="repoRelativePath"/> should be excluded by this <see cref="T:Nerdbank.GitVersioning.FilterPath"/>.
|
|
@@ -316,9 +527,35 @@
|
|
|
316
527
|
Can be empty - which indicates this <c>FilterPath</c> is
|
|
317
528
|
relative to the root of the repository.
|
|
318
529
|
</param>
|
|
319
|
-
<returns>String representation of a path filter (a pathspec)
|
|
530
|
+
<returns>String representation of a path filter (a pathspec).</returns>
|
|
531
|
+
</member>
|
|
532
|
+
<member name="M:Nerdbank.GitVersioning.FilterPath.ToString">
|
|
533
|
+
<inheritdoc/>
|
|
534
|
+
</member>
|
|
535
|
+
<member name="M:Nerdbank.GitVersioning.FilterPath.Normalize(System.String,System.String)">
|
|
536
|
+
<summary>
|
|
537
|
+
Normalizes a pathspec-like string into a root-relative path.
|
|
538
|
+
</summary>
|
|
539
|
+
<param name="path">
|
|
540
|
+
See <see cref="M:Nerdbank.GitVersioning.FilterPath.#ctor(System.String,System.String)"/> for supported
|
|
541
|
+
formats of pathspecs.
|
|
542
|
+
</param>
|
|
543
|
+
<param name="relativeTo">
|
|
544
|
+
Path that <paramref name="path"/> is relative to.
|
|
545
|
+
Can be empty - which indicates <paramref name="path"/> is
|
|
546
|
+
relative to the root of the repository.
|
|
547
|
+
</param>
|
|
548
|
+
<returns>
|
|
549
|
+
Forward slash delimited string representing the root-relative path.
|
|
550
|
+
</returns>
|
|
551
|
+
</member>
|
|
552
|
+
<member name="M:Nerdbank.GitVersioning.FilterPathJsonConverter.CanConvert(System.Type)">
|
|
553
|
+
<inheritdoc/>
|
|
320
554
|
</member>
|
|
321
|
-
<member name="M:Nerdbank.GitVersioning.
|
|
555
|
+
<member name="M:Nerdbank.GitVersioning.FilterPathJsonConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
|
|
556
|
+
<inheritdoc/>
|
|
557
|
+
</member>
|
|
558
|
+
<member name="M:Nerdbank.GitVersioning.FilterPathJsonConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
|
|
322
559
|
<inheritdoc/>
|
|
323
560
|
</member>
|
|
324
561
|
<member name="T:Nerdbank.GitVersioning.GitContext">
|
|
@@ -326,6 +563,12 @@
|
|
|
326
563
|
Represents a location and commit within a git repo and provides access to some version-related git activities.
|
|
327
564
|
</summary>
|
|
328
565
|
</member>
|
|
566
|
+
<member name="F:Nerdbank.GitVersioning.GitContext.MaximumBuildNumberOrRevisionComponent">
|
|
567
|
+
<summary>
|
|
568
|
+
Maximum allowable value for the <see cref="P:System.Version.Build"/>
|
|
569
|
+
and <see cref="P:System.Version.Revision"/> components.
|
|
570
|
+
</summary>
|
|
571
|
+
</member>
|
|
329
572
|
<member name="F:Nerdbank.GitVersioning.GitContext.SemVer0">
|
|
330
573
|
<summary>
|
|
331
574
|
The 0.0 semver.
|
|
@@ -336,12 +579,6 @@
|
|
|
336
579
|
The 0.0 version.
|
|
337
580
|
</summary>
|
|
338
581
|
</member>
|
|
339
|
-
<member name="F:Nerdbank.GitVersioning.GitContext.MaximumBuildNumberOrRevisionComponent">
|
|
340
|
-
<summary>
|
|
341
|
-
Maximum allowable value for the <see cref="P:System.Version.Build"/>
|
|
342
|
-
and <see cref="P:System.Version.Revision"/> components.
|
|
343
|
-
</summary>
|
|
344
|
-
</member>
|
|
345
582
|
<member name="M:Nerdbank.GitVersioning.GitContext.#ctor(System.String,System.String)">
|
|
346
583
|
<summary>Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.GitContext"/> class.</summary>
|
|
347
584
|
<param name="workingTreePath">The absolute path to the root of the working tree.</param>
|
|
@@ -354,7 +591,7 @@
|
|
|
354
591
|
</member>
|
|
355
592
|
<member name="P:Nerdbank.GitVersioning.GitContext.RepoRelativeProjectDirectory">
|
|
356
593
|
<summary>
|
|
357
|
-
Gets the path to the directory to read version information from, relative to the <see cref="P:Nerdbank.GitVersioning.GitContext.WorkingTreePath"/>.
|
|
594
|
+
Gets or sets the path to the directory to read version information from, relative to the <see cref="P:Nerdbank.GitVersioning.GitContext.WorkingTreePath"/>.
|
|
358
595
|
</summary>
|
|
359
596
|
</member>
|
|
360
597
|
<member name="P:Nerdbank.GitVersioning.GitContext.AbsoluteProjectDirectory">
|
|
@@ -369,7 +606,7 @@
|
|
|
369
606
|
</member>
|
|
370
607
|
<member name="P:Nerdbank.GitVersioning.GitContext.IsRepository">
|
|
371
608
|
<summary>
|
|
372
|
-
Gets a value indicating whether a git repository was found at <see cref="P:Nerdbank.GitVersioning.GitContext.WorkingTreePath"
|
|
609
|
+
Gets a value indicating whether a git repository was found at <see cref="P:Nerdbank.GitVersioning.GitContext.WorkingTreePath"/>.
|
|
373
610
|
</summary>
|
|
374
611
|
</member>
|
|
375
612
|
<member name="P:Nerdbank.GitVersioning.GitContext.GitCommitId">
|
|
@@ -394,7 +631,7 @@
|
|
|
394
631
|
</member>
|
|
395
632
|
<member name="P:Nerdbank.GitVersioning.GitContext.HeadCanonicalName">
|
|
396
633
|
<summary>
|
|
397
|
-
Gets the canonical name for HEAD's position (e.g. <c>refs/heads/
|
|
634
|
+
Gets the canonical name for HEAD's position (e.g. <c>refs/heads/main</c>).
|
|
398
635
|
</summary>
|
|
399
636
|
</member>
|
|
400
637
|
<member name="P:Nerdbank.GitVersioning.GitContext.DotGitPath">
|
|
@@ -402,9 +639,6 @@
|
|
|
402
639
|
Gets the path to the .git folder.
|
|
403
640
|
</summary>
|
|
404
641
|
</member>
|
|
405
|
-
<member name="M:Nerdbank.GitVersioning.GitContext.Dispose">
|
|
406
|
-
<inheritdoc />
|
|
407
|
-
</member>
|
|
408
642
|
<member name="M:Nerdbank.GitVersioning.GitContext.Create(System.String,System.String,System.Boolean)">
|
|
409
643
|
<summary>
|
|
410
644
|
Creates a context for reading/writing version information at a given path and committish.
|
|
@@ -412,7 +646,10 @@
|
|
|
412
646
|
<param name="path">The path to a directory for which version information is required.</param>
|
|
413
647
|
<param name="committish">The SHA-1 or ref for a git commit.</param>
|
|
414
648
|
<param name="writable"><see langword="true"/> if mutating the git repository may be required; <see langword="false" /> otherwise.</param>
|
|
415
|
-
<returns
|
|
649
|
+
<returns>The newly created <see cref="T:Nerdbank.GitVersioning.GitContext"/>.</returns>
|
|
650
|
+
</member>
|
|
651
|
+
<member name="M:Nerdbank.GitVersioning.GitContext.Dispose">
|
|
652
|
+
<inheritdoc />
|
|
416
653
|
</member>
|
|
417
654
|
<member name="M:Nerdbank.GitVersioning.GitContext.TrySelectCommit(System.String)">
|
|
418
655
|
<summary>
|
|
@@ -486,8 +723,8 @@
|
|
|
486
723
|
</member>
|
|
487
724
|
<member name="M:Nerdbank.GitVersioning.GitException.#ctor(System.String,System.Exception)">
|
|
488
725
|
<summary>
|
|
489
|
-
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.GitException"/>
|
|
490
|
-
error message and an inner message.
|
|
726
|
+
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.GitException"/> class
|
|
727
|
+
with an error message and an inner message.
|
|
491
728
|
</summary>
|
|
492
729
|
<param name="message">
|
|
493
730
|
A message which describes the error.
|
|
@@ -500,19 +737,7 @@
|
|
|
500
737
|
<summary>
|
|
501
738
|
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.GitException"/> class.
|
|
502
739
|
</summary>
|
|
503
|
-
|
|
504
|
-
<member name="P:Nerdbank.GitVersioning.GitException.ErrorCode">
|
|
505
|
-
<summary>
|
|
506
|
-
Gets the error code for this exception.
|
|
507
|
-
</summary>
|
|
508
|
-
</member>
|
|
509
|
-
<member name="P:Nerdbank.GitVersioning.GitException.iSShallowClone">
|
|
510
|
-
<summary>
|
|
511
|
-
Gets a value indicating whether the exception was thrown from a shallow clone.
|
|
512
|
-
</summary>
|
|
513
|
-
</member>
|
|
514
|
-
<member name="M:Nerdbank.GitVersioning.GitException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
|
|
515
|
-
<inheritdoc/>
|
|
740
|
+
<inheritdoc cref="M:System.Exception.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"/>
|
|
516
741
|
</member>
|
|
517
742
|
<member name="T:Nerdbank.GitVersioning.GitException.ErrorCodes">
|
|
518
743
|
<summary>
|
|
@@ -529,6 +754,19 @@
|
|
|
529
754
|
An object could not be found.
|
|
530
755
|
</summary>
|
|
531
756
|
</member>
|
|
757
|
+
<member name="P:Nerdbank.GitVersioning.GitException.ErrorCode">
|
|
758
|
+
<summary>
|
|
759
|
+
Gets or sets the error code for this exception.
|
|
760
|
+
</summary>
|
|
761
|
+
</member>
|
|
762
|
+
<member name="P:Nerdbank.GitVersioning.GitException.IsShallowClone">
|
|
763
|
+
<summary>
|
|
764
|
+
Gets or sets a value indicating whether the exception was thrown from a shallow clone.
|
|
765
|
+
</summary>
|
|
766
|
+
</member>
|
|
767
|
+
<member name="M:Nerdbank.GitVersioning.GitException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
|
|
768
|
+
<inheritdoc/>
|
|
769
|
+
</member>
|
|
532
770
|
<member name="T:Nerdbank.GitVersioning.ICloudBuild">
|
|
533
771
|
<summary>
|
|
534
772
|
Defines cloud build provider functionality.
|
|
@@ -586,12 +824,6 @@
|
|
|
586
824
|
<member name="P:Nerdbank.GitVersioning.LibGit2.LibGit2Context.VersionFile">
|
|
587
825
|
<inheritdoc />
|
|
588
826
|
</member>
|
|
589
|
-
<member name="P:Nerdbank.GitVersioning.LibGit2.LibGit2Context.Repository">
|
|
590
|
-
<inheritdoc />
|
|
591
|
-
</member>
|
|
592
|
-
<member name="P:Nerdbank.GitVersioning.LibGit2.LibGit2Context.Commit">
|
|
593
|
-
<inheritdoc />
|
|
594
|
-
</member>
|
|
595
827
|
<member name="P:Nerdbank.GitVersioning.LibGit2.LibGit2Context.GitCommitId">
|
|
596
828
|
<inheritdoc />
|
|
597
829
|
</member>
|
|
@@ -604,6 +836,12 @@
|
|
|
604
836
|
<member name="P:Nerdbank.GitVersioning.LibGit2.LibGit2Context.HeadCanonicalName">
|
|
605
837
|
<inheritdoc />
|
|
606
838
|
</member>
|
|
839
|
+
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2Context.Create(System.String,System.String)">
|
|
840
|
+
<summary>Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.LibGit2.LibGit2Context"/> class.</summary>
|
|
841
|
+
<param name="path">The path to the .git directory or somewhere in a git working tree.</param>
|
|
842
|
+
<param name="committish">The SHA-1 or ref for a git commit.</param>
|
|
843
|
+
<returns>The new instance.</returns>
|
|
844
|
+
</member>
|
|
607
845
|
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2Context.ApplyTag(System.String)">
|
|
608
846
|
<inheritdoc />
|
|
609
847
|
</member>
|
|
@@ -616,13 +854,6 @@
|
|
|
616
854
|
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2Context.GetShortUniqueCommitId(System.Int32)">
|
|
617
855
|
<inheritdoc/>
|
|
618
856
|
</member>
|
|
619
|
-
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2Context.Create(System.String,System.String)">
|
|
620
|
-
<param name="path">The path to the .git directory or somewhere in a git working tree.</param>
|
|
621
|
-
<param name="committish">The SHA-1 or ref for a git commit.</param>
|
|
622
|
-
</member>
|
|
623
|
-
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2Context.Dispose(System.Boolean)">
|
|
624
|
-
<inheritdoc />
|
|
625
|
-
</member>
|
|
626
857
|
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2Context.OpenGitRepo(System.String,System.Boolean)">
|
|
627
858
|
<summary>
|
|
628
859
|
Opens a <see cref="P:Nerdbank.GitVersioning.LibGit2.LibGit2Context.Repository"/> found at or above a specified path.
|
|
@@ -631,16 +862,16 @@
|
|
|
631
862
|
<param name="useDefaultConfigSearchPaths">
|
|
632
863
|
Specifies whether to use default settings for looking up global and system settings.
|
|
633
864
|
<para>
|
|
634
|
-
By default (<paramref name="useDefaultConfigSearchPaths"/> == <
|
|
865
|
+
By default (<paramref name="useDefaultConfigSearchPaths"/> == <see langword="false"/>), the repository will be configured to only
|
|
635
866
|
use the repository-level configuration ignoring system or user-level configuration (set using <c>git config --global</c>.
|
|
636
867
|
Thus only settings explicitly set for the repo will be available.
|
|
637
868
|
</para>
|
|
638
869
|
<para>
|
|
639
870
|
For example using <c>Repository.Configuration.Get{string}("user.name")</c> to get the user's name will
|
|
640
|
-
return the value set in the repository config or <
|
|
871
|
+
return the value set in the repository config or <see langword="null"/> if the user name has not been explicitly set for the repository.
|
|
641
872
|
</para>
|
|
642
873
|
<para>
|
|
643
|
-
When the caller specifies to use the default configuration search paths (<paramref name="useDefaultConfigSearchPaths"/> == <
|
|
874
|
+
When the caller specifies to use the default configuration search paths (<paramref name="useDefaultConfigSearchPaths"/> == <see langword="true"/>)
|
|
644
875
|
both repository level and global configuration will be available to the repo as well.
|
|
645
876
|
</para>
|
|
646
877
|
<para>
|
|
@@ -649,13 +880,28 @@
|
|
|
649
880
|
matching the behavior of the <c>git</c> command.
|
|
650
881
|
</para>
|
|
651
882
|
</param>
|
|
652
|
-
<returns>The <see cref="P:Nerdbank.GitVersioning.LibGit2.LibGit2Context.Repository"/> found for the specified path, or <
|
|
883
|
+
<returns>The <see cref="P:Nerdbank.GitVersioning.LibGit2.LibGit2Context.Repository"/> found for the specified path, or <see langword="null"/> if no git repo is found.</returns>
|
|
884
|
+
</member>
|
|
885
|
+
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2Context.CalculateVersionHeight(Nerdbank.GitVersioning.VersionOptions,Nerdbank.GitVersioning.VersionOptions)">
|
|
886
|
+
<inheritdoc/>
|
|
887
|
+
</member>
|
|
888
|
+
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2Context.GetIdAsVersion(Nerdbank.GitVersioning.VersionOptions,Nerdbank.GitVersioning.VersionOptions,System.Int32)">
|
|
889
|
+
<inheritdoc/>
|
|
890
|
+
</member>
|
|
891
|
+
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2Context.Dispose(System.Boolean)">
|
|
892
|
+
<inheritdoc />
|
|
653
893
|
</member>
|
|
654
894
|
<member name="T:Nerdbank.GitVersioning.LibGit2.LibGit2GitExtensions">
|
|
655
895
|
<summary>
|
|
656
896
|
Git extension methods.
|
|
657
897
|
</summary>
|
|
658
898
|
</member>
|
|
899
|
+
<member name="F:Nerdbank.GitVersioning.LibGit2.LibGit2GitExtensions.MaximumBuildNumberOrRevisionComponent">
|
|
900
|
+
<summary>
|
|
901
|
+
Maximum allowable value for the <see cref="P:System.Version.Build"/>
|
|
902
|
+
and <see cref="P:System.Version.Revision"/> components.
|
|
903
|
+
</summary>
|
|
904
|
+
</member>
|
|
659
905
|
<member name="F:Nerdbank.GitVersioning.LibGit2.LibGit2GitExtensions.Version0">
|
|
660
906
|
<summary>
|
|
661
907
|
The 0.0 version.
|
|
@@ -666,22 +912,6 @@
|
|
|
666
912
|
The 0.0 semver.
|
|
667
913
|
</summary>
|
|
668
914
|
</member>
|
|
669
|
-
<member name="F:Nerdbank.GitVersioning.LibGit2.LibGit2GitExtensions.MaximumBuildNumberOrRevisionComponent">
|
|
670
|
-
<summary>
|
|
671
|
-
Maximum allowable value for the <see cref="P:System.Version.Build"/>
|
|
672
|
-
and <see cref="P:System.Version.Revision"/> components.
|
|
673
|
-
</summary>
|
|
674
|
-
</member>
|
|
675
|
-
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2GitExtensions.GetVersionHeight(Nerdbank.GitVersioning.LibGit2.LibGit2Context,System.Version)">
|
|
676
|
-
<summary>
|
|
677
|
-
Gets the number of commits in the longest single path between
|
|
678
|
-
the specified commit and the most distant ancestor (inclusive)
|
|
679
|
-
that set the version to the value at <paramref name="context"/>.
|
|
680
|
-
</summary>
|
|
681
|
-
<param name="context">The git context to read from.</param>
|
|
682
|
-
<param name="baseVersion">Optional base version to calculate the height. If not specified, the base version will be calculated by scanning the repository.</param>
|
|
683
|
-
<returns>The height of the commit. Always a positive integer.</returns>
|
|
684
|
-
</member>
|
|
685
915
|
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2GitExtensions.GetHeight(Nerdbank.GitVersioning.LibGit2.LibGit2Context,System.Func{LibGit2Sharp.Commit,System.Boolean})">
|
|
686
916
|
<summary>
|
|
687
917
|
Gets the number of commits in the longest single path between
|
|
@@ -689,7 +919,7 @@
|
|
|
689
919
|
</summary>
|
|
690
920
|
<param name="context">The git context to read from.</param>
|
|
691
921
|
<param name="continueStepping">
|
|
692
|
-
A function that returns <
|
|
922
|
+
A function that returns <see langword="false"/> when we reach a commit that
|
|
693
923
|
should not be included in the height calculation.
|
|
694
924
|
May be null to count the height to the original commit.
|
|
695
925
|
</param>
|
|
@@ -703,20 +933,13 @@
|
|
|
703
933
|
<param name="commit">The commit to identify with an integer.</param>
|
|
704
934
|
<returns>The unsigned integer which identifies a commit.</returns>
|
|
705
935
|
</member>
|
|
706
|
-
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2GitExtensions.GetRepository(LibGit2Sharp.IBelongToARepository)">
|
|
707
|
-
<summary>
|
|
708
|
-
Returns the repository that <paramref name="repositoryMember"/> belongs to.
|
|
709
|
-
</summary>
|
|
710
|
-
<param name="repositoryMember">Member of the repository.</param>
|
|
711
|
-
<returns>Repository that <paramref name="repositoryMember"/> belongs to.</returns>
|
|
712
|
-
</member>
|
|
713
936
|
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2GitExtensions.GetCommitFromVersion(Nerdbank.GitVersioning.LibGit2.LibGit2Context,System.Version)">
|
|
714
937
|
<summary>
|
|
715
938
|
Looks up the commit that matches a specified version number.
|
|
716
939
|
</summary>
|
|
717
940
|
<param name="context">The git context to read from.</param>
|
|
718
941
|
<param name="version">The version previously obtained from <see cref="P:Nerdbank.GitVersioning.VersionOracle.Version"/>.</param>
|
|
719
|
-
<returns>The matching commit, or <
|
|
942
|
+
<returns>The matching commit, or <see langword="null"/> if no match is found.</returns>
|
|
720
943
|
<exception cref="T:System.InvalidOperationException">
|
|
721
944
|
Thrown in the very rare situation that more than one matching commit is found.
|
|
722
945
|
</exception>
|
|
@@ -736,26 +959,61 @@
|
|
|
736
959
|
<param name="basePath">The path to the directory that contains the lib folder.</param>
|
|
737
960
|
<returns>Receives the directory that native binaries are expected.</returns>
|
|
738
961
|
</member>
|
|
962
|
+
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2GitExtensions.GetVersionHeight(Nerdbank.GitVersioning.LibGit2.LibGit2Context,System.Version)">
|
|
963
|
+
<summary>
|
|
964
|
+
Gets the number of commits in the longest single path between
|
|
965
|
+
the specified commit and the most distant ancestor (inclusive)
|
|
966
|
+
that set the version to the value at <paramref name="context"/>.
|
|
967
|
+
</summary>
|
|
968
|
+
<param name="context">The git context to read from.</param>
|
|
969
|
+
<param name="baseVersion">Optional base version to calculate the height. If not specified, the base version will be calculated by scanning the repository.</param>
|
|
970
|
+
<returns>The height of the commit. Always a positive integer.</returns>
|
|
971
|
+
</member>
|
|
972
|
+
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2GitExtensions.GetIdAsVersionHelper(LibGit2Sharp.Commit,Nerdbank.GitVersioning.VersionOptions,System.Int32)">
|
|
973
|
+
<summary>
|
|
974
|
+
Encodes a commit from history in a <see cref="T:System.Version"/>
|
|
975
|
+
so that the original commit can be found later.
|
|
976
|
+
</summary>
|
|
977
|
+
<param name="commit">The commit whose ID and position in history is to be encoded.</param>
|
|
978
|
+
<param name="versionOptions">The version options applicable at this point (either from commit or working copy).</param>
|
|
979
|
+
<param name="versionHeight">The version height, previously calculated by a call to <see cref="M:Nerdbank.GitVersioning.LibGit2.LibGit2GitExtensions.GetVersionHeight(Nerdbank.GitVersioning.LibGit2.LibGit2Context,System.Version)"/>.</param>
|
|
980
|
+
<returns>
|
|
981
|
+
A version whose <see cref="P:System.Version.Build"/> and
|
|
982
|
+
<see cref="P:System.Version.Revision"/> components are calculated based on the commit.
|
|
983
|
+
</returns>
|
|
984
|
+
<remarks>
|
|
985
|
+
In the returned version, the <see cref="P:System.Version.Build"/> component is
|
|
986
|
+
the height of the git commit while the <see cref="P:System.Version.Revision"/>
|
|
987
|
+
component is the first four bytes of the git commit id (forced to be a positive integer).
|
|
988
|
+
</remarks>
|
|
989
|
+
</member>
|
|
990
|
+
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2GitExtensions.GetRepository(LibGit2Sharp.IBelongToARepository)">
|
|
991
|
+
<summary>
|
|
992
|
+
Returns the repository that <paramref name="repositoryMember"/> belongs to.
|
|
993
|
+
</summary>
|
|
994
|
+
<param name="repositoryMember">Member of the repository.</param>
|
|
995
|
+
<returns>Repository that <paramref name="repositoryMember"/> belongs to.</returns>
|
|
996
|
+
</member>
|
|
739
997
|
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2GitExtensions.CommitMatchesVersion(LibGit2Sharp.Commit,Nerdbank.GitVersioning.SemanticVersion,Nerdbank.GitVersioning.SemanticVersion.Position,Nerdbank.GitVersioning.LibGit2.LibGit2GitExtensions.GitWalkTracker)">
|
|
740
998
|
<summary>
|
|
741
999
|
Tests whether a commit is of a specified version, comparing major and minor components
|
|
742
1000
|
with the version.txt file defined by that commit.
|
|
743
1001
|
</summary>
|
|
744
1002
|
<param name="commit">The commit to test.</param>
|
|
745
|
-
<param name="expectedVersion">The version to test for in the commit
|
|
1003
|
+
<param name="expectedVersion">The version to test for in the commit.</param>
|
|
746
1004
|
<param name="comparisonPrecision">The last component of the version to include in the comparison.</param>
|
|
747
1005
|
<param name="tracker">The caching tracker for storing or fetching version information per commit.</param>
|
|
748
|
-
<returns><
|
|
1006
|
+
<returns><see langword="true"/> if the <paramref name="commit"/> matches the major and minor components of <paramref name="expectedVersion"/>.</returns>
|
|
749
1007
|
</member>
|
|
750
1008
|
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2GitExtensions.CommitMatchesVersion(LibGit2Sharp.Commit,System.Version,Nerdbank.GitVersioning.SemanticVersion.Position,Nerdbank.GitVersioning.LibGit2.LibGit2GitExtensions.GitWalkTracker)">
|
|
751
1009
|
<summary>
|
|
752
1010
|
Tests whether a commit's version-spec matches a given version-spec.
|
|
753
1011
|
</summary>
|
|
754
1012
|
<param name="commit">The commit to test.</param>
|
|
755
|
-
<param name="expectedVersion">The version to test for in the commit
|
|
1013
|
+
<param name="expectedVersion">The version to test for in the commit.</param>
|
|
756
1014
|
<param name="comparisonPrecision">The last component of the version to include in the comparison.</param>
|
|
757
1015
|
<param name="tracker">The caching tracker for storing or fetching version information per commit.</param>
|
|
758
|
-
<returns><
|
|
1016
|
+
<returns><see langword="true"/> if the <paramref name="commit"/> matches the major and minor components of <paramref name="expectedVersion"/>.</returns>
|
|
759
1017
|
</member>
|
|
760
1018
|
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2GitExtensions.StartsWith(LibGit2Sharp.ObjectId,System.UInt16,System.Boolean,System.UInt16)">
|
|
761
1019
|
<summary>
|
|
@@ -763,8 +1021,8 @@
|
|
|
763
1021
|
</summary>
|
|
764
1022
|
<param name="object">The object whose ID is to be tested.</param>
|
|
765
1023
|
<param name="leadingBytes">The leading 16-bits to be tested.</param>
|
|
766
|
-
<param name="bitMask">The mask that indicates which bits should be compared.</param>
|
|
767
1024
|
<param name="bigEndian"><see langword="true"/> to read the first two bytes as big endian (v3.5+ behavior); <see langword="false"/> to use little endian (v3.4 and earlier behavior).</param>
|
|
1025
|
+
<param name="bitMask">The mask that indicates which bits should be compared.</param>
|
|
768
1026
|
<returns><c>True</c> if the object's ID starts with <paramref name="leadingBytes"/> after applying the <paramref name="bitMask"/>.</returns>
|
|
769
1027
|
</member>
|
|
770
1028
|
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2GitExtensions.EncodeAsHex(System.Byte[])">
|
|
@@ -782,7 +1040,7 @@
|
|
|
782
1040
|
<param name="startingCommit">The commit to measure the height of.</param>
|
|
783
1041
|
<param name="tracker">The caching tracker for storing or fetching version information per commit.</param>
|
|
784
1042
|
<param name="continueStepping">
|
|
785
|
-
A function that returns <
|
|
1043
|
+
A function that returns <see langword="false"/> when we reach a commit that
|
|
786
1044
|
should not be included in the height calculation.
|
|
787
1045
|
May be null to count the height to the original commit.
|
|
788
1046
|
</param>
|
|
@@ -795,24 +1053,6 @@
|
|
|
795
1053
|
<param name="repo">The repo to search.</param>
|
|
796
1054
|
<returns>An enumerate of commits.</returns>
|
|
797
1055
|
</member>
|
|
798
|
-
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2GitExtensions.GetIdAsVersionHelper(LibGit2Sharp.Commit,Nerdbank.GitVersioning.VersionOptions,System.Int32)">
|
|
799
|
-
<summary>
|
|
800
|
-
Encodes a commit from history in a <see cref="T:System.Version"/>
|
|
801
|
-
so that the original commit can be found later.
|
|
802
|
-
</summary>
|
|
803
|
-
<param name="commit">The commit whose ID and position in history is to be encoded.</param>
|
|
804
|
-
<param name="versionOptions">The version options applicable at this point (either from commit or working copy).</param>
|
|
805
|
-
<param name="versionHeight">The version height, previously calculated by a call to <see cref="M:Nerdbank.GitVersioning.LibGit2.LibGit2GitExtensions.GetVersionHeight(Nerdbank.GitVersioning.LibGit2.LibGit2Context,System.Version)"/>.</param>
|
|
806
|
-
<returns>
|
|
807
|
-
A version whose <see cref="P:System.Version.Build"/> and
|
|
808
|
-
<see cref="P:System.Version.Revision"/> components are calculated based on the commit.
|
|
809
|
-
</returns>
|
|
810
|
-
<remarks>
|
|
811
|
-
In the returned version, the <see cref="P:System.Version.Build"/> component is
|
|
812
|
-
the height of the git commit while the <see cref="P:System.Version.Revision"/>
|
|
813
|
-
component is the first four bytes of the git commit id (forced to be a positive integer).
|
|
814
|
-
</remarks>
|
|
815
|
-
</member>
|
|
816
1056
|
<member name="T:Nerdbank.GitVersioning.LibGit2.LibGit2VersionFile">
|
|
817
1057
|
<summary>
|
|
818
1058
|
Exposes queries and mutations on a version.json or version.txt file,
|
|
@@ -834,6 +1074,9 @@
|
|
|
834
1074
|
<param name="actualDirectory">Receives the full path to the directory in which the version file was found.</param>
|
|
835
1075
|
<returns>The version information read from the file.</returns>
|
|
836
1076
|
</member>
|
|
1077
|
+
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2VersionFile.GetVersionCore(System.String@)">
|
|
1078
|
+
<inheritdoc/>
|
|
1079
|
+
</member>
|
|
837
1080
|
<member name="T:Nerdbank.GitVersioning.ManagedGit.DeltaInstruction">
|
|
838
1081
|
<summary>
|
|
839
1082
|
Represents an instruction in a deltified stream.
|
|
@@ -963,12 +1206,6 @@
|
|
|
963
1206
|
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitCommit.Equals(Nerdbank.GitVersioning.ManagedGit.GitCommit)">
|
|
964
1207
|
<inheritdoc/>
|
|
965
1208
|
</member>
|
|
966
|
-
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitCommit.op_Equality(Nerdbank.GitVersioning.ManagedGit.GitCommit,Nerdbank.GitVersioning.ManagedGit.GitCommit)">
|
|
967
|
-
<inheritdoc/>
|
|
968
|
-
</member>
|
|
969
|
-
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitCommit.op_Inequality(Nerdbank.GitVersioning.ManagedGit.GitCommit,Nerdbank.GitVersioning.ManagedGit.GitCommit)">
|
|
970
|
-
<inheritdoc/>
|
|
971
|
-
</member>
|
|
972
1209
|
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitCommit.GetHashCode">
|
|
973
1210
|
<inheritdoc/>
|
|
974
1211
|
</member>
|
|
@@ -982,7 +1219,7 @@
|
|
|
982
1219
|
</member>
|
|
983
1220
|
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitCommit.ParentEnumerable.#ctor(Nerdbank.GitVersioning.ManagedGit.GitCommit)">
|
|
984
1221
|
<summary>
|
|
985
|
-
Initializes
|
|
1222
|
+
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitCommit.ParentEnumerable"/> struct.
|
|
986
1223
|
</summary>
|
|
987
1224
|
<param name="owner">The commit whose parents are to be enumerated.</param>
|
|
988
1225
|
</member>
|
|
@@ -999,7 +1236,7 @@
|
|
|
999
1236
|
</member>
|
|
1000
1237
|
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitCommit.ParentEnumerator.#ctor(Nerdbank.GitVersioning.ManagedGit.GitCommit)">
|
|
1001
1238
|
<summary>
|
|
1002
|
-
Initializes
|
|
1239
|
+
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitCommit.ParentEnumerator"/> struct.
|
|
1003
1240
|
</summary>
|
|
1004
1241
|
<param name="owner">The commit whose parents are to be enumerated.</param>
|
|
1005
1242
|
</member>
|
|
@@ -1065,14 +1302,14 @@
|
|
|
1065
1302
|
</summary>
|
|
1066
1303
|
<seealso href="https://git-scm.com/book/en/v2/Git-Internals-Git-Objects"/>.
|
|
1067
1304
|
</member>
|
|
1068
|
-
<member name="P:Nerdbank.GitVersioning.ManagedGit.GitObjectId.
|
|
1305
|
+
<member name="P:Nerdbank.GitVersioning.ManagedGit.GitObjectId.Empty">
|
|
1069
1306
|
<summary>
|
|
1070
|
-
Gets
|
|
1307
|
+
Gets a <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitObjectId"/> which represents an empty <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitObjectId"/>.
|
|
1071
1308
|
</summary>
|
|
1072
1309
|
</member>
|
|
1073
|
-
<member name="P:Nerdbank.GitVersioning.ManagedGit.GitObjectId.
|
|
1310
|
+
<member name="P:Nerdbank.GitVersioning.ManagedGit.GitObjectId.Value">
|
|
1074
1311
|
<summary>
|
|
1075
|
-
Gets
|
|
1312
|
+
Gets the 20 byte ID of this object as a span from the <see cref="F:Nerdbank.GitVersioning.ManagedGit.GitObjectId.value"/> field.
|
|
1076
1313
|
</summary>
|
|
1077
1314
|
</member>
|
|
1078
1315
|
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitObjectId.Parse(System.ReadOnlySpan{System.Byte})">
|
|
@@ -1119,12 +1356,6 @@
|
|
|
1119
1356
|
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitObjectId.Equals(Nerdbank.GitVersioning.ManagedGit.GitObjectId)">
|
|
1120
1357
|
<inheritdoc/>
|
|
1121
1358
|
</member>
|
|
1122
|
-
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitObjectId.op_Equality(Nerdbank.GitVersioning.ManagedGit.GitObjectId,Nerdbank.GitVersioning.ManagedGit.GitObjectId)">
|
|
1123
|
-
<inheritdoc/>
|
|
1124
|
-
</member>
|
|
1125
|
-
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitObjectId.op_Inequality(Nerdbank.GitVersioning.ManagedGit.GitObjectId,Nerdbank.GitVersioning.ManagedGit.GitObjectId)">
|
|
1126
|
-
<inheritdoc/>
|
|
1127
|
-
</member>
|
|
1128
1359
|
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitObjectId.GetHashCode">
|
|
1129
1360
|
<inheritdoc/>
|
|
1130
1361
|
</member>
|
|
@@ -1140,6 +1371,7 @@
|
|
|
1140
1371
|
<summary>
|
|
1141
1372
|
Returns the SHA1 hash of this object.
|
|
1142
1373
|
</summary>
|
|
1374
|
+
<inheritdoc />
|
|
1143
1375
|
</member>
|
|
1144
1376
|
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitObjectId.CopyAsHex(System.Int32,System.Int32,System.Span{System.Char})">
|
|
1145
1377
|
<summary>
|
|
@@ -1201,20 +1433,6 @@
|
|
|
1201
1433
|
Supports retrieving objects from a Git pack file.
|
|
1202
1434
|
</summary>
|
|
1203
1435
|
</member>
|
|
1204
|
-
<member name="T:Nerdbank.GitVersioning.ManagedGit.GitPack.GetObjectFromRepositoryDelegate">
|
|
1205
|
-
<summary>
|
|
1206
|
-
A delegate for methods which fetch objects from the Git object store.
|
|
1207
|
-
</summary>
|
|
1208
|
-
<param name="sha">
|
|
1209
|
-
The Git object ID of the object to fetch.
|
|
1210
|
-
</param>
|
|
1211
|
-
<param name="objectType">
|
|
1212
|
-
The object type of the object to fetch.
|
|
1213
|
-
</param>
|
|
1214
|
-
<returns>
|
|
1215
|
-
A <see cref="T:System.IO.Stream"/> which represents the requested object.
|
|
1216
|
-
</returns>
|
|
1217
|
-
</member>
|
|
1218
1436
|
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitPack.#ctor(Nerdbank.GitVersioning.ManagedGit.GitPack.GetObjectFromRepositoryDelegate,System.String,System.String,Nerdbank.GitVersioning.ManagedGit.GitPackCache)">
|
|
1219
1437
|
<summary>
|
|
1220
1438
|
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitPack"/> class.
|
|
@@ -1253,6 +1471,20 @@
|
|
|
1253
1471
|
on the pack file.
|
|
1254
1472
|
</param>
|
|
1255
1473
|
</member>
|
|
1474
|
+
<member name="T:Nerdbank.GitVersioning.ManagedGit.GitPack.GetObjectFromRepositoryDelegate">
|
|
1475
|
+
<summary>
|
|
1476
|
+
A delegate for methods which fetch objects from the Git object store.
|
|
1477
|
+
</summary>
|
|
1478
|
+
<param name="sha">
|
|
1479
|
+
The Git object ID of the object to fetch.
|
|
1480
|
+
</param>
|
|
1481
|
+
<param name="objectType">
|
|
1482
|
+
The object type of the object to fetch.
|
|
1483
|
+
</param>
|
|
1484
|
+
<returns>
|
|
1485
|
+
A <see cref="T:System.IO.Stream"/> which represents the requested object.
|
|
1486
|
+
</returns>
|
|
1487
|
+
</member>
|
|
1256
1488
|
<member name="P:Nerdbank.GitVersioning.ManagedGit.GitPack.GetObjectFromRepository">
|
|
1257
1489
|
<summary>
|
|
1258
1490
|
Gets a delegate which fetches objects from the Git object store.
|
|
@@ -1517,12 +1749,75 @@
|
|
|
1517
1749
|
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCache.Dispose(System.Boolean)">
|
|
1518
1750
|
<inheritdoc/>
|
|
1519
1751
|
</member>
|
|
1752
|
+
<member name="P:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheStream.CanRead">
|
|
1753
|
+
<inheritdoc/>
|
|
1754
|
+
</member>
|
|
1755
|
+
<member name="P:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheStream.CanSeek">
|
|
1756
|
+
<inheritdoc/>
|
|
1757
|
+
</member>
|
|
1758
|
+
<member name="P:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheStream.CanWrite">
|
|
1759
|
+
<inheritdoc/>
|
|
1760
|
+
</member>
|
|
1761
|
+
<member name="P:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheStream.Length">
|
|
1762
|
+
<inheritdoc/>
|
|
1763
|
+
</member>
|
|
1764
|
+
<member name="P:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheStream.Position">
|
|
1765
|
+
<inheritdoc/>
|
|
1766
|
+
</member>
|
|
1767
|
+
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheStream.Flush">
|
|
1768
|
+
<inheritdoc/>
|
|
1769
|
+
</member>
|
|
1520
1770
|
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheStream.Read(System.Span{System.Byte})">
|
|
1521
1771
|
<inheritdoc/>
|
|
1522
1772
|
</member>
|
|
1773
|
+
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheStream.Read(System.Byte[],System.Int32,System.Int32)">
|
|
1774
|
+
<inheritdoc/>
|
|
1775
|
+
</member>
|
|
1776
|
+
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheStream.Seek(System.Int64,System.IO.SeekOrigin)">
|
|
1777
|
+
<inheritdoc/>
|
|
1778
|
+
</member>
|
|
1779
|
+
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheStream.SetLength(System.Int64)">
|
|
1780
|
+
<inheritdoc/>
|
|
1781
|
+
</member>
|
|
1782
|
+
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheStream.Write(System.Byte[],System.Int32,System.Int32)">
|
|
1783
|
+
<inheritdoc/>
|
|
1784
|
+
</member>
|
|
1785
|
+
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheStream.Dispose(System.Boolean)">
|
|
1786
|
+
<inheritdoc/>
|
|
1787
|
+
</member>
|
|
1788
|
+
<member name="P:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheViewStream.CanRead">
|
|
1789
|
+
<inheritdoc/>
|
|
1790
|
+
</member>
|
|
1791
|
+
<member name="P:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheViewStream.CanSeek">
|
|
1792
|
+
<inheritdoc/>
|
|
1793
|
+
</member>
|
|
1794
|
+
<member name="P:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheViewStream.CanWrite">
|
|
1795
|
+
<inheritdoc/>
|
|
1796
|
+
</member>
|
|
1797
|
+
<member name="P:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheViewStream.Length">
|
|
1798
|
+
<inheritdoc/>
|
|
1799
|
+
</member>
|
|
1800
|
+
<member name="P:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheViewStream.Position">
|
|
1801
|
+
<inheritdoc/>
|
|
1802
|
+
</member>
|
|
1803
|
+
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheViewStream.Flush">
|
|
1804
|
+
<inheritdoc/>
|
|
1805
|
+
</member>
|
|
1806
|
+
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheViewStream.Read(System.Byte[],System.Int32,System.Int32)">
|
|
1807
|
+
<inheritdoc/>
|
|
1808
|
+
</member>
|
|
1523
1809
|
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheViewStream.Read(System.Span{System.Byte})">
|
|
1524
1810
|
<inheritdoc/>
|
|
1525
1811
|
</member>
|
|
1812
|
+
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheViewStream.Seek(System.Int64,System.IO.SeekOrigin)">
|
|
1813
|
+
<inheritdoc/>
|
|
1814
|
+
</member>
|
|
1815
|
+
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheViewStream.SetLength(System.Int64)">
|
|
1816
|
+
<inheritdoc/>
|
|
1817
|
+
</member>
|
|
1818
|
+
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCacheViewStream.Write(System.Byte[],System.Int32,System.Int32)">
|
|
1819
|
+
<inheritdoc/>
|
|
1820
|
+
</member>
|
|
1526
1821
|
<member name="T:Nerdbank.GitVersioning.ManagedGit.GitPackNullCache">
|
|
1527
1822
|
<summary>
|
|
1528
1823
|
A no-op implementation of the <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitPackCache"/> class.
|
|
@@ -1542,6 +1837,41 @@
|
|
|
1542
1837
|
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackNullCache.GetCacheStatistics(System.Text.StringBuilder)">
|
|
1543
1838
|
<inheritdoc/>
|
|
1544
1839
|
</member>
|
|
1840
|
+
<member name="F:Nerdbank.GitVersioning.ManagedGit.GitPackObjectType.Invalid">
|
|
1841
|
+
<summary>
|
|
1842
|
+
Invalid.
|
|
1843
|
+
</summary>
|
|
1844
|
+
</member>
|
|
1845
|
+
<member name="F:Nerdbank.GitVersioning.ManagedGit.GitPackObjectType.OBJ_COMMIT">
|
|
1846
|
+
<summary>
|
|
1847
|
+
A commit.
|
|
1848
|
+
</summary>
|
|
1849
|
+
</member>
|
|
1850
|
+
<member name="F:Nerdbank.GitVersioning.ManagedGit.GitPackObjectType.OBJ_TREE">
|
|
1851
|
+
<summary>
|
|
1852
|
+
A tree.
|
|
1853
|
+
</summary>
|
|
1854
|
+
</member>
|
|
1855
|
+
<member name="F:Nerdbank.GitVersioning.ManagedGit.GitPackObjectType.OBJ_BLOB">
|
|
1856
|
+
<summary>
|
|
1857
|
+
A blob.
|
|
1858
|
+
</summary>
|
|
1859
|
+
</member>
|
|
1860
|
+
<member name="F:Nerdbank.GitVersioning.ManagedGit.GitPackObjectType.OBJ_TAG">
|
|
1861
|
+
<summary>
|
|
1862
|
+
A tag.
|
|
1863
|
+
</summary>
|
|
1864
|
+
</member>
|
|
1865
|
+
<member name="F:Nerdbank.GitVersioning.ManagedGit.GitPackObjectType.OBJ_OFS_DELTA">
|
|
1866
|
+
<summary>
|
|
1867
|
+
An OFS_DELTA.
|
|
1868
|
+
</summary>
|
|
1869
|
+
</member>
|
|
1870
|
+
<member name="F:Nerdbank.GitVersioning.ManagedGit.GitPackObjectType.OBJ_REF_DELTA">
|
|
1871
|
+
<summary>
|
|
1872
|
+
A REF_DELTA.
|
|
1873
|
+
</summary>
|
|
1874
|
+
</member>
|
|
1545
1875
|
<member name="T:Nerdbank.GitVersioning.ManagedGit.GitPackPooledStream">
|
|
1546
1876
|
<summary>
|
|
1547
1877
|
A pooled <see cref="T:System.IO.Stream"/>, which wraps around a
|
|
@@ -1611,25 +1941,6 @@
|
|
|
1611
1941
|
UTF-16 encoded string.
|
|
1612
1942
|
</summary>
|
|
1613
1943
|
</member>
|
|
1614
|
-
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.Create(System.String)">
|
|
1615
|
-
<summary>
|
|
1616
|
-
Creates a new instance of the <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitRepository"/> class.
|
|
1617
|
-
</summary>
|
|
1618
|
-
<param name="workingDirectory"><inheritdoc cref="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.#ctor(System.String,System.String,System.String,System.String)" path="/param[@name='workingDirectory']" /></param>
|
|
1619
|
-
<returns>
|
|
1620
|
-
A <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitRepository"/> which represents the git repository, or <see langword="null"/>
|
|
1621
|
-
if no git repository was found.
|
|
1622
|
-
</returns>
|
|
1623
|
-
</member>
|
|
1624
|
-
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.Create(System.String,System.String,System.String,System.String)">
|
|
1625
|
-
<summary>
|
|
1626
|
-
Creates a new instance of the <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitRepository"/> class.
|
|
1627
|
-
</summary>
|
|
1628
|
-
<param name="workingDirectory"><inheritdoc cref="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.#ctor(System.String,System.String,System.String,System.String)" path="/param[@name='workingDirectory']" /></param>
|
|
1629
|
-
<param name="gitDirectory"><inheritdoc cref="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.#ctor(System.String,System.String,System.String,System.String)" path="/param[@name='gitDirectory']" /> </param>
|
|
1630
|
-
<param name="commonDirectory"><inheritdoc cref="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.#ctor(System.String,System.String,System.String,System.String)" path="/param[@name='commonDirectory']" /></param>
|
|
1631
|
-
<param name="objectDirectory"><inheritdoc cref="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.#ctor(System.String,System.String,System.String,System.String)" path="/param[@name='objectDirectory']" /></param>
|
|
1632
|
-
</member>
|
|
1633
1944
|
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.#ctor(System.String,System.String,System.String,System.String)">
|
|
1634
1945
|
<summary>
|
|
1635
1946
|
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitRepository"/> class.
|
|
@@ -1647,6 +1958,11 @@
|
|
|
1647
1958
|
The object directory in which Git objects are stored.
|
|
1648
1959
|
</param>
|
|
1649
1960
|
</member>
|
|
1961
|
+
<member name="P:Nerdbank.GitVersioning.ManagedGit.GitRepository.Encoding">
|
|
1962
|
+
<summary>
|
|
1963
|
+
Gets the encoding used by this Git repository.
|
|
1964
|
+
</summary>
|
|
1965
|
+
</member>
|
|
1650
1966
|
<member name="P:Nerdbank.GitVersioning.ManagedGit.GitRepository.IgnoreCase">
|
|
1651
1967
|
<summary>
|
|
1652
1968
|
Gets a value indicating whether this Git repository is case-insensitive.
|
|
@@ -1673,14 +1989,65 @@
|
|
|
1673
1989
|
Gets the path to the Git object directory. It is a subdirectory of <see cref="P:Nerdbank.GitVersioning.ManagedGit.GitRepository.CommonDirectory"/>.
|
|
1674
1990
|
</summary>
|
|
1675
1991
|
</member>
|
|
1676
|
-
<member name="
|
|
1992
|
+
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.Create(System.String)">
|
|
1677
1993
|
<summary>
|
|
1678
|
-
|
|
1994
|
+
Creates a new instance of the <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitRepository"/> class.
|
|
1995
|
+
</summary>
|
|
1996
|
+
<param name="workingDirectory"><inheritdoc cref="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.#ctor(System.String,System.String,System.String,System.String)" path="/param[@name='workingDirectory']" /></param>
|
|
1997
|
+
<returns>
|
|
1998
|
+
A <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitRepository"/> which represents the git repository, or <see langword="null"/>
|
|
1999
|
+
if no git repository was found.
|
|
2000
|
+
</returns>
|
|
2001
|
+
</member>
|
|
2002
|
+
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.Create(System.String,System.String,System.String,System.String)">
|
|
2003
|
+
<summary>
|
|
2004
|
+
Creates a new instance of the <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitRepository"/> class.
|
|
2005
|
+
</summary>
|
|
2006
|
+
<param name="workingDirectory"><inheritdoc cref="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.#ctor(System.String,System.String,System.String,System.String)" path="/param[@name='workingDirectory']" /></param>
|
|
2007
|
+
<param name="gitDirectory"><inheritdoc cref="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.#ctor(System.String,System.String,System.String,System.String)" path="/param[@name='gitDirectory']" /> </param>
|
|
2008
|
+
<param name="commonDirectory"><inheritdoc cref="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.#ctor(System.String,System.String,System.String,System.String)" path="/param[@name='commonDirectory']" /></param>
|
|
2009
|
+
<param name="objectDirectory"><inheritdoc cref="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.#ctor(System.String,System.String,System.String,System.String)" path="/param[@name='objectDirectory']" /></param>
|
|
2010
|
+
<returns>A newly created instance.</returns>
|
|
2011
|
+
</member>
|
|
2012
|
+
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.GetString(System.ReadOnlySpan{System.Byte})">
|
|
2013
|
+
<summary>
|
|
2014
|
+
Decodes a sequence of bytes from the specified byte array into a <see cref="T:System.String"/>.
|
|
2015
|
+
</summary>
|
|
2016
|
+
<param name="bytes">
|
|
2017
|
+
The span containing the sequence of UTF-8 bytes to decode.
|
|
2018
|
+
</param>
|
|
2019
|
+
<returns>
|
|
2020
|
+
A <see cref="T:System.String"/> that contains the results of decoding the specified sequence of bytes.
|
|
2021
|
+
</returns>
|
|
2022
|
+
</member>
|
|
2023
|
+
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.ParseAlternates(System.ReadOnlySpan{System.Byte})">
|
|
2024
|
+
<summary>
|
|
2025
|
+
Parses the contents of the alternates file, and returns a list of (relative) paths to the alternate object directories.
|
|
2026
|
+
</summary>
|
|
2027
|
+
<param name="alternates">
|
|
2028
|
+
The contents of the alternates files.
|
|
2029
|
+
</param>
|
|
2030
|
+
<returns>
|
|
2031
|
+
A list of (relative) paths to the alternate object directories.
|
|
2032
|
+
</returns>
|
|
2033
|
+
</member>
|
|
2034
|
+
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.ParseAlternates(System.ReadOnlySpan{System.Byte},System.Int32)">
|
|
2035
|
+
<summary>
|
|
2036
|
+
Parses the contents of the alternates file, and returns a list of (relative) paths to the alternate object directories.
|
|
1679
2037
|
</summary>
|
|
2038
|
+
<param name="alternates">
|
|
2039
|
+
The contents of the alternates files.
|
|
2040
|
+
</param>
|
|
2041
|
+
<param name="skipCount">
|
|
2042
|
+
The number of bytes to skip in the span when looking for a delimiter.
|
|
2043
|
+
</param>
|
|
2044
|
+
<returns>
|
|
2045
|
+
A list of (relative) paths to the alternate object directories.
|
|
2046
|
+
</returns>
|
|
1680
2047
|
</member>
|
|
1681
2048
|
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.ShortenObjectId(Nerdbank.GitVersioning.ManagedGit.GitObjectId,System.Int32)">
|
|
1682
2049
|
<summary>
|
|
1683
|
-
Shortens the object id
|
|
2050
|
+
Shortens the object id.
|
|
1684
2051
|
</summary>
|
|
1685
2052
|
<param name="objectId">
|
|
1686
2053
|
The object Id to shorten.
|
|
@@ -1819,42 +2186,6 @@
|
|
|
1819
2186
|
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.Dispose">
|
|
1820
2187
|
<inheritdoc/>
|
|
1821
2188
|
</member>
|
|
1822
|
-
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.GetString(System.ReadOnlySpan{System.Byte})">
|
|
1823
|
-
<summary>
|
|
1824
|
-
Decodes a sequence of bytes from the specified byte array into a <see cref="T:System.String"/>.
|
|
1825
|
-
</summary>
|
|
1826
|
-
<param name="bytes">
|
|
1827
|
-
The span containing the sequence of UTF-8 bytes to decode.
|
|
1828
|
-
</param>
|
|
1829
|
-
<returns>
|
|
1830
|
-
A <see cref="T:System.String"/> that contains the results of decoding the specified sequence of bytes.
|
|
1831
|
-
</returns>
|
|
1832
|
-
</member>
|
|
1833
|
-
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.ParseAlternates(System.ReadOnlySpan{System.Byte})">
|
|
1834
|
-
<summary>
|
|
1835
|
-
Parses the contents of the alternates file, and returns a list of (relative) paths to the alternate object directories.
|
|
1836
|
-
</summary>
|
|
1837
|
-
<param name="alternates">
|
|
1838
|
-
The contents of the alternates files.
|
|
1839
|
-
</param>
|
|
1840
|
-
<returns>
|
|
1841
|
-
A list of (relative) paths to the alternate object directories.
|
|
1842
|
-
</returns>
|
|
1843
|
-
</member>
|
|
1844
|
-
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.ParseAlternates(System.ReadOnlySpan{System.Byte},System.Int32)">
|
|
1845
|
-
<summary>
|
|
1846
|
-
Parses the contents of the alternates file, and returns a list of (relative) paths to the alternate object directories.
|
|
1847
|
-
</summary>
|
|
1848
|
-
<param name="alternates">
|
|
1849
|
-
The contents of the alternates files.
|
|
1850
|
-
</param>
|
|
1851
|
-
<param name="skipCount">
|
|
1852
|
-
The number of bytes to skip in the span when looking for a delimiter.
|
|
1853
|
-
</param>
|
|
1854
|
-
<returns>
|
|
1855
|
-
A list of (relative) paths to the alternate object directories.
|
|
1856
|
-
</returns>
|
|
1857
|
-
</member>
|
|
1858
2189
|
<member name="T:Nerdbank.GitVersioning.ManagedGit.GitSignature">
|
|
1859
2190
|
<summary>
|
|
1860
2191
|
Represents the signature of a Git committer or author.
|
|
@@ -1887,7 +2218,7 @@
|
|
|
1887
2218
|
</member>
|
|
1888
2219
|
<member name="P:Nerdbank.GitVersioning.ManagedGit.GitTree.Sha">
|
|
1889
2220
|
<summary>
|
|
1890
|
-
|
|
2221
|
+
Gets or sets the Git object Id of this <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitObjectId"/>.
|
|
1891
2222
|
</summary>
|
|
1892
2223
|
</member>
|
|
1893
2224
|
<member name="P:Nerdbank.GitVersioning.ManagedGit.GitTree.Children">
|
|
@@ -2135,16 +2466,72 @@
|
|
|
2135
2466
|
The length of this <see cref="T:Nerdbank.GitVersioning.ManagedGit.ZLibStream"/> class.
|
|
2136
2467
|
</param>
|
|
2137
2468
|
</member>
|
|
2138
|
-
<member name="
|
|
2469
|
+
<member name="F:Nerdbank.GitVersioning.Managed.GitExtensions.SemVer0">
|
|
2139
2470
|
<summary>
|
|
2140
|
-
|
|
2471
|
+
The 0.0 semver.
|
|
2141
2472
|
</summary>
|
|
2142
2473
|
</member>
|
|
2143
|
-
<member name="
|
|
2144
|
-
<
|
|
2474
|
+
<member name="M:Nerdbank.GitVersioning.Managed.GitExtensions.GetHeight(Nerdbank.GitVersioning.Managed.ManagedGitContext,System.Func{Nerdbank.GitVersioning.ManagedGit.GitCommit,System.Boolean})">
|
|
2475
|
+
<summary>
|
|
2476
|
+
Gets the number of commits in the longest single path between
|
|
2477
|
+
the specified commit and the most distant ancestor (inclusive).
|
|
2478
|
+
</summary>
|
|
2479
|
+
<param name="context">The git context.</param>
|
|
2480
|
+
<param name="continueStepping">
|
|
2481
|
+
A function that returns <see langword="false"/> when we reach a commit that
|
|
2482
|
+
should not be included in the height calculation.
|
|
2483
|
+
May be null to count the height to the original commit.
|
|
2484
|
+
</param>
|
|
2485
|
+
<returns>The height of the commit. Always a positive integer.</returns>
|
|
2145
2486
|
</member>
|
|
2146
|
-
<member name="
|
|
2147
|
-
<
|
|
2487
|
+
<member name="M:Nerdbank.GitVersioning.Managed.GitExtensions.GetTruncatedCommitIdAsUInt16(Nerdbank.GitVersioning.ManagedGit.GitCommit)">
|
|
2488
|
+
<summary>
|
|
2489
|
+
Takes the first 2 bytes of a commit ID (i.e. first 4 characters of its hex-encoded SHA)
|
|
2490
|
+
and returns them as an 16-bit unsigned integer.
|
|
2491
|
+
</summary>
|
|
2492
|
+
<param name="commit">The commit to identify with an integer.</param>
|
|
2493
|
+
<returns>The unsigned integer which identifies a commit.</returns>
|
|
2494
|
+
</member>
|
|
2495
|
+
<member name="M:Nerdbank.GitVersioning.Managed.GitExtensions.GetVersionHeight(Nerdbank.GitVersioning.Managed.ManagedGitContext,System.Version)">
|
|
2496
|
+
<summary>
|
|
2497
|
+
Gets the number of commits in the longest single path between
|
|
2498
|
+
the specified commit and the most distant ancestor (inclusive)
|
|
2499
|
+
that set the version to the value at <paramref name="context"/>.
|
|
2500
|
+
</summary>
|
|
2501
|
+
<param name="context">The git context for which to calculate the height.</param>
|
|
2502
|
+
<param name="baseVersion">Optional base version to calculate the height. If not specified, the base version will be calculated by scanning the repository.</param>
|
|
2503
|
+
<returns>The height of the commit. Always a positive integer.</returns>
|
|
2504
|
+
</member>
|
|
2505
|
+
<member name="M:Nerdbank.GitVersioning.Managed.GitExtensions.GetCommitHeight(Nerdbank.GitVersioning.ManagedGit.GitRepository,Nerdbank.GitVersioning.ManagedGit.GitCommit,Nerdbank.GitVersioning.Managed.GitExtensions.GitWalkTracker,System.Func{Nerdbank.GitVersioning.ManagedGit.GitCommit,System.Boolean})">
|
|
2506
|
+
<summary>
|
|
2507
|
+
Gets the number of commits in the longest single path between
|
|
2508
|
+
the specified branch's head and the most distant ancestor (inclusive).
|
|
2509
|
+
</summary>
|
|
2510
|
+
<param name="repository">The Git repository.</param>
|
|
2511
|
+
<param name="startingCommit">The commit to measure the height of.</param>
|
|
2512
|
+
<param name="tracker">The caching tracker for storing or fetching version information per commit.</param>
|
|
2513
|
+
<param name="continueStepping">
|
|
2514
|
+
A function that returns <see langword="false"/> when we reach a commit that
|
|
2515
|
+
should not be included in the height calculation.
|
|
2516
|
+
May be null to count the height to the original commit.
|
|
2517
|
+
</param>
|
|
2518
|
+
<returns>The height of the branch.</returns>
|
|
2519
|
+
</member>
|
|
2520
|
+
<member name="M:Nerdbank.GitVersioning.Managed.GitExtensions.CommitMatchesVersion(Nerdbank.GitVersioning.ManagedGit.GitCommit,Nerdbank.GitVersioning.SemanticVersion,Nerdbank.GitVersioning.SemanticVersion.Position,Nerdbank.GitVersioning.Managed.GitExtensions.GitWalkTracker)">
|
|
2521
|
+
<summary>
|
|
2522
|
+
Tests whether a commit is of a specified version, comparing major and minor components
|
|
2523
|
+
with the version.txt file defined by that commit.
|
|
2524
|
+
</summary>
|
|
2525
|
+
<param name="commit">The commit to test.</param>
|
|
2526
|
+
<param name="expectedVersion">The version to test for in the commit.</param>
|
|
2527
|
+
<param name="comparisonPrecision">The last component of the version to include in the comparison.</param>
|
|
2528
|
+
<param name="tracker">The caching tracker for storing or fetching version information per commit.</param>
|
|
2529
|
+
<returns><see langword="true"/> if the <paramref name="commit"/> matches the major and minor components of <paramref name="expectedVersion"/>.</returns>
|
|
2530
|
+
</member>
|
|
2531
|
+
<member name="T:Nerdbank.GitVersioning.Managed.ManagedGitContext">
|
|
2532
|
+
<summary>
|
|
2533
|
+
A git context implemented without any native code dependency.
|
|
2534
|
+
</summary>
|
|
2148
2535
|
</member>
|
|
2149
2536
|
<member name="P:Nerdbank.GitVersioning.Managed.ManagedGitContext.VersionFile">
|
|
2150
2537
|
<inheritdoc />
|
|
@@ -2161,6 +2548,12 @@
|
|
|
2161
2548
|
<member name="P:Nerdbank.GitVersioning.Managed.ManagedGitContext.HeadCanonicalName">
|
|
2162
2549
|
<inheritdoc />
|
|
2163
2550
|
</member>
|
|
2551
|
+
<member name="M:Nerdbank.GitVersioning.Managed.ManagedGitContext.Create(System.String,System.String)">
|
|
2552
|
+
<summary>Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.Managed.ManagedGitContext"/> class.</summary>
|
|
2553
|
+
<param name="path">The path to the .git directory or somewhere in a git working tree.</param>
|
|
2554
|
+
<param name="committish">The SHA-1 or ref for a git commit.</param>
|
|
2555
|
+
<returns>The new instance.</returns>
|
|
2556
|
+
</member>
|
|
2164
2557
|
<member name="M:Nerdbank.GitVersioning.Managed.ManagedGitContext.ApplyTag(System.String)">
|
|
2165
2558
|
<inheritdoc />
|
|
2166
2559
|
</member>
|
|
@@ -2170,13 +2563,15 @@
|
|
|
2170
2563
|
<member name="M:Nerdbank.GitVersioning.Managed.ManagedGitContext.Stage(System.String)">
|
|
2171
2564
|
<inheritdoc />
|
|
2172
2565
|
</member>
|
|
2173
|
-
<member name="M:Nerdbank.GitVersioning.Managed.ManagedGitContext.Create(System.String,System.String)">
|
|
2174
|
-
<param name="path">The path to the .git directory or somewhere in a git working tree.</param>
|
|
2175
|
-
<param name="committish">The SHA-1 or ref for a git commit.</param>
|
|
2176
|
-
</member>
|
|
2177
2566
|
<member name="M:Nerdbank.GitVersioning.Managed.ManagedGitContext.GetShortUniqueCommitId(System.Int32)">
|
|
2178
2567
|
<inheritdoc/>
|
|
2179
2568
|
</member>
|
|
2569
|
+
<member name="M:Nerdbank.GitVersioning.Managed.ManagedGitContext.CalculateVersionHeight(Nerdbank.GitVersioning.VersionOptions,Nerdbank.GitVersioning.VersionOptions)">
|
|
2570
|
+
<inheritdoc/>
|
|
2571
|
+
</member>
|
|
2572
|
+
<member name="M:Nerdbank.GitVersioning.Managed.ManagedGitContext.GetIdAsVersion(Nerdbank.GitVersioning.VersionOptions,Nerdbank.GitVersioning.VersionOptions,System.Int32)">
|
|
2573
|
+
<inheritdoc/>
|
|
2574
|
+
</member>
|
|
2180
2575
|
<member name="M:Nerdbank.GitVersioning.Managed.ManagedGitContext.Dispose(System.Boolean)">
|
|
2181
2576
|
<inheritdoc/>
|
|
2182
2577
|
</member>
|
|
@@ -2188,76 +2583,14 @@
|
|
|
2188
2583
|
<param name="versionOptions">The version options applicable at this point (either from commit or working copy).</param>
|
|
2189
2584
|
<param name="versionHeight">The version height, previously calculated.</param>
|
|
2190
2585
|
<returns>
|
|
2191
|
-
A version whose <see cref="P:System.Version.Build"/> and
|
|
2192
|
-
<see cref="P:System.Version.Revision"/> components are calculated based on the commit.
|
|
2193
|
-
</returns>
|
|
2194
|
-
<remarks>
|
|
2195
|
-
In the returned version, the <see cref="P:System.Version.Build"/> component is
|
|
2196
|
-
the height of the git commit while the <see cref="P:System.Version.Revision"/>
|
|
2197
|
-
component is the first four bytes of the git commit id (forced to be a positive integer).
|
|
2198
|
-
</remarks>
|
|
2199
|
-
</member>
|
|
2200
|
-
<member name="F:Nerdbank.GitVersioning.Managed.GitExtensions.SemVer0">
|
|
2201
|
-
<summary>
|
|
2202
|
-
The 0.0 semver.
|
|
2203
|
-
</summary>
|
|
2204
|
-
</member>
|
|
2205
|
-
<member name="M:Nerdbank.GitVersioning.Managed.GitExtensions.GetVersionHeight(Nerdbank.GitVersioning.Managed.ManagedGitContext,System.Version)">
|
|
2206
|
-
<summary>
|
|
2207
|
-
Gets the number of commits in the longest single path between
|
|
2208
|
-
the specified commit and the most distant ancestor (inclusive)
|
|
2209
|
-
that set the version to the value at <paramref name="context"/>.
|
|
2210
|
-
</summary>
|
|
2211
|
-
<param name="context">The git context for which to calculate the height.</param>
|
|
2212
|
-
<param name="baseVersion">Optional base version to calculate the height. If not specified, the base version will be calculated by scanning the repository.</param>
|
|
2213
|
-
<returns>The height of the commit. Always a positive integer.</returns>
|
|
2214
|
-
</member>
|
|
2215
|
-
<member name="M:Nerdbank.GitVersioning.Managed.GitExtensions.CommitMatchesVersion(Nerdbank.GitVersioning.ManagedGit.GitCommit,Nerdbank.GitVersioning.SemanticVersion,Nerdbank.GitVersioning.SemanticVersion.Position,Nerdbank.GitVersioning.Managed.GitExtensions.GitWalkTracker)">
|
|
2216
|
-
<summary>
|
|
2217
|
-
Tests whether a commit is of a specified version, comparing major and minor components
|
|
2218
|
-
with the version.txt file defined by that commit.
|
|
2219
|
-
</summary>
|
|
2220
|
-
<param name="commit">The commit to test.</param>
|
|
2221
|
-
<param name="expectedVersion">The version to test for in the commit</param>
|
|
2222
|
-
<param name="comparisonPrecision">The last component of the version to include in the comparison.</param>
|
|
2223
|
-
<param name="tracker">The caching tracker for storing or fetching version information per commit.</param>
|
|
2224
|
-
<returns><c>true</c> if the <paramref name="commit"/> matches the major and minor components of <paramref name="expectedVersion"/>.</returns>
|
|
2225
|
-
</member>
|
|
2226
|
-
<member name="M:Nerdbank.GitVersioning.Managed.GitExtensions.GetHeight(Nerdbank.GitVersioning.Managed.ManagedGitContext,System.Func{Nerdbank.GitVersioning.ManagedGit.GitCommit,System.Boolean})">
|
|
2227
|
-
<summary>
|
|
2228
|
-
Gets the number of commits in the longest single path between
|
|
2229
|
-
the specified commit and the most distant ancestor (inclusive).
|
|
2230
|
-
</summary>
|
|
2231
|
-
<param name="context">The git context.</param>
|
|
2232
|
-
<param name="continueStepping">
|
|
2233
|
-
A function that returns <c>false</c> when we reach a commit that
|
|
2234
|
-
should not be included in the height calculation.
|
|
2235
|
-
May be null to count the height to the original commit.
|
|
2236
|
-
</param>
|
|
2237
|
-
<returns>The height of the commit. Always a positive integer.</returns>
|
|
2238
|
-
</member>
|
|
2239
|
-
<member name="M:Nerdbank.GitVersioning.Managed.GitExtensions.GetCommitHeight(Nerdbank.GitVersioning.ManagedGit.GitRepository,Nerdbank.GitVersioning.ManagedGit.GitCommit,Nerdbank.GitVersioning.Managed.GitExtensions.GitWalkTracker,System.Func{Nerdbank.GitVersioning.ManagedGit.GitCommit,System.Boolean})">
|
|
2240
|
-
<summary>
|
|
2241
|
-
Gets the number of commits in the longest single path between
|
|
2242
|
-
the specified branch's head and the most distant ancestor (inclusive).
|
|
2243
|
-
</summary>
|
|
2244
|
-
<param name="repository">The Git repository.</param>
|
|
2245
|
-
<param name="startingCommit">The commit to measure the height of.</param>
|
|
2246
|
-
<param name="tracker">The caching tracker for storing or fetching version information per commit.</param>
|
|
2247
|
-
<param name="continueStepping">
|
|
2248
|
-
A function that returns <c>false</c> when we reach a commit that
|
|
2249
|
-
should not be included in the height calculation.
|
|
2250
|
-
May be null to count the height to the original commit.
|
|
2251
|
-
</param>
|
|
2252
|
-
<returns>The height of the branch.</returns>
|
|
2253
|
-
</member>
|
|
2254
|
-
<member name="M:Nerdbank.GitVersioning.Managed.GitExtensions.GetTruncatedCommitIdAsUInt16(Nerdbank.GitVersioning.ManagedGit.GitCommit)">
|
|
2255
|
-
<summary>
|
|
2256
|
-
Takes the first 2 bytes of a commit ID (i.e. first 4 characters of its hex-encoded SHA)
|
|
2257
|
-
and returns them as an 16-bit unsigned integer.
|
|
2258
|
-
</summary>
|
|
2259
|
-
<param name="commit">The commit to identify with an integer.</param>
|
|
2260
|
-
<returns>The unsigned integer which identifies a commit.</returns>
|
|
2586
|
+
A version whose <see cref="P:System.Version.Build"/> and
|
|
2587
|
+
<see cref="P:System.Version.Revision"/> components are calculated based on the commit.
|
|
2588
|
+
</returns>
|
|
2589
|
+
<remarks>
|
|
2590
|
+
In the returned version, the <see cref="P:System.Version.Build"/> component is
|
|
2591
|
+
the height of the git commit while the <see cref="P:System.Version.Revision"/>
|
|
2592
|
+
component is the first four bytes of the git commit id (forced to be a positive integer).
|
|
2593
|
+
</remarks>
|
|
2261
2594
|
</member>
|
|
2262
2595
|
<member name="T:Nerdbank.GitVersioning.Managed.ManagedVersionFile">
|
|
2263
2596
|
<summary>
|
|
@@ -2291,57 +2624,103 @@
|
|
|
2291
2624
|
<param name="actualDirectory">Receives the full path to the directory in which the version file was found.</param>
|
|
2292
2625
|
<returns>The version information read from the file.</returns>
|
|
2293
2626
|
</member>
|
|
2627
|
+
<member name="M:Nerdbank.GitVersioning.Managed.ManagedVersionFile.GetVersionCore(System.String@)">
|
|
2628
|
+
<inheritdoc/>
|
|
2629
|
+
</member>
|
|
2630
|
+
<member name="P:Nerdbank.GitVersioning.NoGitContext.VersionFile">
|
|
2631
|
+
<inheritdoc/>
|
|
2632
|
+
</member>
|
|
2633
|
+
<member name="P:Nerdbank.GitVersioning.NoGitContext.GitCommitId">
|
|
2634
|
+
<inheritdoc/>
|
|
2635
|
+
</member>
|
|
2636
|
+
<member name="P:Nerdbank.GitVersioning.NoGitContext.IsHead">
|
|
2637
|
+
<inheritdoc/>
|
|
2638
|
+
</member>
|
|
2639
|
+
<member name="P:Nerdbank.GitVersioning.NoGitContext.GitCommitDate">
|
|
2640
|
+
<inheritdoc/>
|
|
2641
|
+
</member>
|
|
2642
|
+
<member name="P:Nerdbank.GitVersioning.NoGitContext.HeadCanonicalName">
|
|
2643
|
+
<inheritdoc/>
|
|
2644
|
+
</member>
|
|
2645
|
+
<member name="M:Nerdbank.GitVersioning.NoGitContext.ApplyTag(System.String)">
|
|
2646
|
+
<inheritdoc/>
|
|
2647
|
+
</member>
|
|
2648
|
+
<member name="M:Nerdbank.GitVersioning.NoGitContext.Stage(System.String)">
|
|
2649
|
+
<inheritdoc/>
|
|
2650
|
+
</member>
|
|
2651
|
+
<member name="M:Nerdbank.GitVersioning.NoGitContext.GetShortUniqueCommitId(System.Int32)">
|
|
2652
|
+
<inheritdoc/>
|
|
2653
|
+
</member>
|
|
2654
|
+
<member name="M:Nerdbank.GitVersioning.NoGitContext.TrySelectCommit(System.String)">
|
|
2655
|
+
<inheritdoc/>
|
|
2656
|
+
</member>
|
|
2657
|
+
<member name="M:Nerdbank.GitVersioning.NoGitContext.CalculateVersionHeight(Nerdbank.GitVersioning.VersionOptions,Nerdbank.GitVersioning.VersionOptions)">
|
|
2658
|
+
<inheritdoc/>
|
|
2659
|
+
</member>
|
|
2660
|
+
<member name="M:Nerdbank.GitVersioning.NoGitContext.GetIdAsVersion(Nerdbank.GitVersioning.VersionOptions,Nerdbank.GitVersioning.VersionOptions,System.Int32)">
|
|
2661
|
+
<inheritdoc/>
|
|
2662
|
+
</member>
|
|
2663
|
+
<member name="M:Nerdbank.GitVersioning.NoGitVersionFile.GetVersionCore(System.String@)">
|
|
2664
|
+
<inheritdoc/>
|
|
2665
|
+
</member>
|
|
2294
2666
|
<member name="T:Nerdbank.GitVersioning.ReleaseManager">
|
|
2295
2667
|
<summary>
|
|
2296
|
-
Methods for creating releases
|
|
2668
|
+
Methods for creating releases.
|
|
2297
2669
|
</summary>
|
|
2298
2670
|
<remarks>
|
|
2299
2671
|
This class authors git commits, branches, etc. and thus must use libgit2 rather than our internal managed implementation which is read-only.
|
|
2300
2672
|
</remarks>
|
|
2301
2673
|
</member>
|
|
2674
|
+
<member name="M:Nerdbank.GitVersioning.ReleaseManager.#ctor(System.IO.TextWriter,System.IO.TextWriter)">
|
|
2675
|
+
<summary>
|
|
2676
|
+
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.ReleaseManager"/> class.
|
|
2677
|
+
</summary>
|
|
2678
|
+
<param name="outputWriter">The <see cref="T:System.IO.TextWriter"/> to write output to (e.g. <see cref="P:System.Console.Out" />).</param>
|
|
2679
|
+
<param name="errorWriter">The <see cref="T:System.IO.TextWriter"/> to write error messages to (e.g. <see cref="P:System.Console.Error" />).</param>
|
|
2680
|
+
</member>
|
|
2302
2681
|
<member name="T:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationError">
|
|
2303
2682
|
<summary>
|
|
2304
|
-
Defines the possible errors that can occur when preparing a release
|
|
2683
|
+
Defines the possible errors that can occur when preparing a release.
|
|
2305
2684
|
</summary>
|
|
2306
2685
|
</member>
|
|
2307
2686
|
<member name="F:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationError.NoGitRepo">
|
|
2308
2687
|
<summary>
|
|
2309
|
-
The project directory is not a git repository
|
|
2688
|
+
The project directory is not a git repository.
|
|
2310
2689
|
</summary>
|
|
2311
2690
|
</member>
|
|
2312
2691
|
<member name="F:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationError.UncommittedChanges">
|
|
2313
2692
|
<summary>
|
|
2314
|
-
There are pending changes in the project directory
|
|
2693
|
+
There are pending changes in the project directory.
|
|
2315
2694
|
</summary>
|
|
2316
2695
|
</member>
|
|
2317
2696
|
<member name="F:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationError.InvalidBranchNameSetting">
|
|
2318
2697
|
<summary>
|
|
2319
|
-
The "branchName" setting in "version.json" is invalid
|
|
2698
|
+
The "branchName" setting in "version.json" is invalid.
|
|
2320
2699
|
</summary>
|
|
2321
2700
|
</member>
|
|
2322
2701
|
<member name="F:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationError.NoVersionFile">
|
|
2323
2702
|
<summary>
|
|
2324
|
-
version.json/version.txt not found
|
|
2703
|
+
version.json/version.txt not found.
|
|
2325
2704
|
</summary>
|
|
2326
2705
|
</member>
|
|
2327
2706
|
<member name="F:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationError.VersionDecrement">
|
|
2328
2707
|
<summary>
|
|
2329
|
-
Updating the version would result in a version lower than the previous version
|
|
2708
|
+
Updating the version would result in a version lower than the previous version.
|
|
2330
2709
|
</summary>
|
|
2331
2710
|
</member>
|
|
2332
2711
|
<member name="F:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationError.NoVersionIncrement">
|
|
2333
2712
|
<summary>
|
|
2334
|
-
Branch cannot be set to the specified version because the new version is not higher than the current version
|
|
2713
|
+
Branch cannot be set to the specified version because the new version is not higher than the current version.
|
|
2335
2714
|
</summary>
|
|
2336
2715
|
</member>
|
|
2337
2716
|
<member name="F:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationError.BranchAlreadyExists">
|
|
2338
2717
|
<summary>
|
|
2339
|
-
Cannot create a branch because it already exists
|
|
2718
|
+
Cannot create a branch because it already exists.
|
|
2340
2719
|
</summary>
|
|
2341
2720
|
</member>
|
|
2342
2721
|
<member name="F:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationError.UserNotConfigured">
|
|
2343
2722
|
<summary>
|
|
2344
|
-
Cannot create a commit because user name and user email are not configured (either at the repo or global level)
|
|
2723
|
+
Cannot create a commit because user name and user email are not configured (either at the repo or global level).
|
|
2345
2724
|
</summary>
|
|
2346
2725
|
</member>
|
|
2347
2726
|
<member name="F:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationError.DetachedHead">
|
|
@@ -2354,135 +2733,128 @@
|
|
|
2354
2733
|
The versionIncrement setting cannot be applied to the current version.
|
|
2355
2734
|
</summary>
|
|
2356
2735
|
</member>
|
|
2357
|
-
<member name="T:Nerdbank.GitVersioning.ReleaseManager.
|
|
2736
|
+
<member name="T:Nerdbank.GitVersioning.ReleaseManager.ReleaseManagerOutputMode">
|
|
2358
2737
|
<summary>
|
|
2359
|
-
|
|
2738
|
+
Enumerates the output formats supported by <see cref="T:Nerdbank.GitVersioning.ReleaseManager"/>.
|
|
2360
2739
|
</summary>
|
|
2361
2740
|
</member>
|
|
2362
|
-
<member name="
|
|
2741
|
+
<member name="F:Nerdbank.GitVersioning.ReleaseManager.ReleaseManagerOutputMode.Text">
|
|
2363
2742
|
<summary>
|
|
2364
|
-
|
|
2743
|
+
Use unstructured text output.
|
|
2744
|
+
</summary>
|
|
2745
|
+
</member>
|
|
2746
|
+
<member name="F:Nerdbank.GitVersioning.ReleaseManager.ReleaseManagerOutputMode.Json">
|
|
2747
|
+
<summary>
|
|
2748
|
+
Output information about the release as JSON.
|
|
2749
|
+
</summary>
|
|
2750
|
+
</member>
|
|
2751
|
+
<member name="M:Nerdbank.GitVersioning.ReleaseManager.PrepareRelease(System.String,System.String,System.Version,System.Nullable{Nerdbank.GitVersioning.VersionOptions.ReleaseVersionIncrement},Nerdbank.GitVersioning.ReleaseManager.ReleaseManagerOutputMode)">
|
|
2752
|
+
<summary>
|
|
2753
|
+
Prepares a release for the specified directory by creating a release branch and incrementing the version in the current branch.
|
|
2754
|
+
</summary>
|
|
2755
|
+
<exception cref="T:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationException">Thrown when the release could not be created.</exception>
|
|
2756
|
+
<param name="projectDirectory">
|
|
2757
|
+
The path to the directory which may (or its ancestors may) define the version file.
|
|
2758
|
+
</param>
|
|
2759
|
+
<param name="releaseUnstableTag">
|
|
2760
|
+
The prerelease tag to add to the version on the release branch. Pass <see langword="null"/> to omit/remove the prerelease tag.
|
|
2761
|
+
The leading hyphen may be specified or omitted.
|
|
2762
|
+
</param>
|
|
2763
|
+
<param name="nextVersion">
|
|
2764
|
+
The next version to save to the version file on the current branch. Pass <see langword="null"/> to automatically determine the next
|
|
2765
|
+
version based on the current version and the <paramref name="versionIncrement"/> setting in <c>version.json</c>.
|
|
2766
|
+
Parameter will be ignored if the current branch is a release branch.
|
|
2767
|
+
</param>
|
|
2768
|
+
<param name="versionIncrement">
|
|
2769
|
+
The increment to apply in order to determine the next version on the current branch.
|
|
2770
|
+
If specified, value will be used instead of the increment specified in <c>version.json</c>.
|
|
2771
|
+
Parameter will be ignored if the current branch is a release branch.
|
|
2772
|
+
</param>
|
|
2773
|
+
<param name="outputMode">
|
|
2774
|
+
The output format to use for writing to stdout.
|
|
2775
|
+
</param>
|
|
2776
|
+
</member>
|
|
2777
|
+
<member name="T:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationException">
|
|
2778
|
+
<summary>
|
|
2779
|
+
Exception indicating an error during preparation of a release.
|
|
2365
2780
|
</summary>
|
|
2366
2781
|
</member>
|
|
2367
2782
|
<member name="M:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationException.#ctor(Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationError)">
|
|
2368
2783
|
<summary>
|
|
2369
|
-
Initializes a new instance of <see cref="T:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationException"/>
|
|
2784
|
+
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationException"/> class.
|
|
2370
2785
|
</summary>
|
|
2371
2786
|
<param name="error">The error that occurred.</param>
|
|
2372
2787
|
</member>
|
|
2373
2788
|
<member name="M:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationException.#ctor(Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationError,System.Exception)">
|
|
2374
2789
|
<summary>
|
|
2375
|
-
Initializes a new instance of <see cref="T:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationException"/>
|
|
2790
|
+
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationException"/> class.
|
|
2376
2791
|
</summary>
|
|
2377
2792
|
<param name="error">The error that occurred.</param>
|
|
2378
2793
|
<param name="innerException">The inner exception.</param>
|
|
2379
2794
|
</member>
|
|
2380
|
-
<member name="
|
|
2381
|
-
<summary>
|
|
2382
|
-
Encapsulates information on a release created through <see cref="T:Nerdbank.GitVersioning.ReleaseManager"/>.
|
|
2383
|
-
</summary>
|
|
2384
|
-
</member>
|
|
2385
|
-
<member name="P:Nerdbank.GitVersioning.ReleaseManager.ReleaseInfo.CurrentBranch">
|
|
2795
|
+
<member name="P:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationException.Error">
|
|
2386
2796
|
<summary>
|
|
2387
|
-
Gets
|
|
2797
|
+
Gets the error that occurred.
|
|
2388
2798
|
</summary>
|
|
2389
2799
|
</member>
|
|
2390
|
-
<member name="
|
|
2800
|
+
<member name="T:Nerdbank.GitVersioning.ReleaseManager.ReleaseInfo">
|
|
2391
2801
|
<summary>
|
|
2392
|
-
|
|
2802
|
+
Encapsulates information on a release created through <see cref="T:Nerdbank.GitVersioning.ReleaseManager"/>.
|
|
2393
2803
|
</summary>
|
|
2394
|
-
<value>
|
|
2395
|
-
Information on the newly created branch as instance of <see cref="T:Nerdbank.GitVersioning.ReleaseManager.ReleaseBranchInfo"/> or <c>null</c>, if no new branch was created.
|
|
2396
|
-
</value>
|
|
2397
2804
|
</member>
|
|
2398
2805
|
<member name="M:Nerdbank.GitVersioning.ReleaseManager.ReleaseInfo.#ctor(Nerdbank.GitVersioning.ReleaseManager.ReleaseBranchInfo)">
|
|
2399
2806
|
<summary>
|
|
2400
|
-
Initializes a new instance of <see cref="T:Nerdbank.GitVersioning.ReleaseManager.ReleaseInfo"
|
|
2807
|
+
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.ReleaseManager.ReleaseInfo"/> class.
|
|
2401
2808
|
</summary>
|
|
2402
2809
|
<param name="currentBranch">Information on the branch the release was created from.</param>
|
|
2403
2810
|
</member>
|
|
2404
2811
|
<member name="M:Nerdbank.GitVersioning.ReleaseManager.ReleaseInfo.#ctor(Nerdbank.GitVersioning.ReleaseManager.ReleaseBranchInfo,Nerdbank.GitVersioning.ReleaseManager.ReleaseBranchInfo)">
|
|
2405
2812
|
<summary>
|
|
2406
|
-
Initializes a new instance of <see cref="T:Nerdbank.GitVersioning.ReleaseManager.ReleaseInfo"
|
|
2813
|
+
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.ReleaseManager.ReleaseInfo"/> class.
|
|
2407
2814
|
</summary>
|
|
2408
2815
|
<param name="currentBranch">Information on the branch the release was created from.</param>
|
|
2409
2816
|
<param name="newBranch">Information on the newly created branch.</param>
|
|
2410
2817
|
</member>
|
|
2411
|
-
<member name="
|
|
2412
|
-
<summary>
|
|
2413
|
-
Encapsulates information on a branch created or updated by <see cref="T:Nerdbank.GitVersioning.ReleaseManager"/>.
|
|
2414
|
-
</summary>
|
|
2415
|
-
</member>
|
|
2416
|
-
<member name="P:Nerdbank.GitVersioning.ReleaseManager.ReleaseBranchInfo.Name">
|
|
2818
|
+
<member name="P:Nerdbank.GitVersioning.ReleaseManager.ReleaseInfo.CurrentBranch">
|
|
2417
2819
|
<summary>
|
|
2418
|
-
|
|
2820
|
+
Gets information on the 'current' branch, i.e. the branch the release was created from.
|
|
2419
2821
|
</summary>
|
|
2420
2822
|
</member>
|
|
2421
|
-
<member name="P:Nerdbank.GitVersioning.ReleaseManager.
|
|
2823
|
+
<member name="P:Nerdbank.GitVersioning.ReleaseManager.ReleaseInfo.NewBranch">
|
|
2422
2824
|
<summary>
|
|
2423
|
-
|
|
2825
|
+
Gets information on the new branch created by <see cref="T:Nerdbank.GitVersioning.ReleaseManager"/>.
|
|
2424
2826
|
</summary>
|
|
2827
|
+
<value>
|
|
2828
|
+
Information on the newly created branch as instance of <see cref="T:Nerdbank.GitVersioning.ReleaseManager.ReleaseBranchInfo"/> or <see langword="null"/>, if no new branch was created.
|
|
2829
|
+
</value>
|
|
2425
2830
|
</member>
|
|
2426
|
-
<member name="
|
|
2831
|
+
<member name="T:Nerdbank.GitVersioning.ReleaseManager.ReleaseBranchInfo">
|
|
2427
2832
|
<summary>
|
|
2428
|
-
|
|
2833
|
+
Encapsulates information on a branch created or updated by <see cref="T:Nerdbank.GitVersioning.ReleaseManager"/>.
|
|
2429
2834
|
</summary>
|
|
2430
2835
|
</member>
|
|
2431
2836
|
<member name="M:Nerdbank.GitVersioning.ReleaseManager.ReleaseBranchInfo.#ctor(System.String,System.String,Nerdbank.GitVersioning.SemanticVersion)">
|
|
2432
2837
|
<summary>
|
|
2433
|
-
Initializes a new instance of <see cref="T:Nerdbank.GitVersioning.ReleaseManager.ReleaseBranchInfo"
|
|
2838
|
+
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.ReleaseManager.ReleaseBranchInfo"/> class.
|
|
2434
2839
|
</summary>
|
|
2435
2840
|
<param name="name">The name of the branch.</param>
|
|
2436
2841
|
<param name="commit">The id of the branch's tip.</param>
|
|
2437
2842
|
<param name="version">The version configured in the branch's <c>version.json</c>.</param>
|
|
2438
2843
|
</member>
|
|
2439
|
-
<member name="
|
|
2440
|
-
<summary>
|
|
2441
|
-
Enumerates the output formats supported by <see cref="T:Nerdbank.GitVersioning.ReleaseManager"/>.
|
|
2442
|
-
</summary>
|
|
2443
|
-
</member>
|
|
2444
|
-
<member name="F:Nerdbank.GitVersioning.ReleaseManager.ReleaseManagerOutputMode.Text">
|
|
2445
|
-
<summary>
|
|
2446
|
-
Use unstructured text output.
|
|
2447
|
-
</summary>
|
|
2448
|
-
</member>
|
|
2449
|
-
<member name="F:Nerdbank.GitVersioning.ReleaseManager.ReleaseManagerOutputMode.Json">
|
|
2844
|
+
<member name="P:Nerdbank.GitVersioning.ReleaseManager.ReleaseBranchInfo.Name">
|
|
2450
2845
|
<summary>
|
|
2451
|
-
|
|
2846
|
+
Gets the name of the branch, e.g. <c>main</c>.
|
|
2452
2847
|
</summary>
|
|
2453
2848
|
</member>
|
|
2454
|
-
<member name="
|
|
2849
|
+
<member name="P:Nerdbank.GitVersioning.ReleaseManager.ReleaseBranchInfo.Commit">
|
|
2455
2850
|
<summary>
|
|
2456
|
-
|
|
2851
|
+
Gets the id of the branch's tip commit after the update.
|
|
2457
2852
|
</summary>
|
|
2458
|
-
<param name="outputWriter">The <see cref="T:System.IO.TextWriter"/> to write output to (e.g. <see cref="P:System.Console.Out" />).</param>
|
|
2459
|
-
<param name="errorWriter">The <see cref="T:System.IO.TextWriter"/> to write error messages to (e.g. <see cref="P:System.Console.Error" />).</param>
|
|
2460
2853
|
</member>
|
|
2461
|
-
<member name="
|
|
2854
|
+
<member name="P:Nerdbank.GitVersioning.ReleaseManager.ReleaseBranchInfo.Version">
|
|
2462
2855
|
<summary>
|
|
2463
|
-
|
|
2856
|
+
Gets the version configured in the branch's <c>version.json</c>.
|
|
2464
2857
|
</summary>
|
|
2465
|
-
<exception cref="T:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationException">Thrown when the release could not be created.</exception>
|
|
2466
|
-
<param name="projectDirectory">
|
|
2467
|
-
The path to the directory which may (or its ancestors may) define the version file.
|
|
2468
|
-
</param>
|
|
2469
|
-
<param name="releaseUnstableTag">
|
|
2470
|
-
The prerelease tag to add to the version on the release branch. Pass <c>null</c> to omit/remove the prerelease tag.
|
|
2471
|
-
The leading hyphen may be specified or omitted.
|
|
2472
|
-
</param>
|
|
2473
|
-
<param name="nextVersion">
|
|
2474
|
-
The next version to save to the version file on the current branch. Pass <c>null</c> to automatically determine the next
|
|
2475
|
-
version based on the current version and the <c>versionIncrement</c> setting in <c>version.json</c>.
|
|
2476
|
-
Parameter will be ignored if the current branch is a release branch.
|
|
2477
|
-
</param>
|
|
2478
|
-
<param name="versionIncrement">
|
|
2479
|
-
The increment to apply in order to determine the next version on the current branch.
|
|
2480
|
-
If specified, value will be used instead of the increment specified in <c>version.json</c>.
|
|
2481
|
-
Parameter will be ignored if the current branch is a release branch.
|
|
2482
|
-
</param>
|
|
2483
|
-
<param name="outputMode">
|
|
2484
|
-
The output format to use for writing to stdout.
|
|
2485
|
-
</param>
|
|
2486
2858
|
</member>
|
|
2487
2859
|
<member name="T:Nerdbank.GitVersioning.SemanticVersion">
|
|
2488
2860
|
<summary>
|
|
@@ -2495,7 +2867,7 @@
|
|
|
2495
2867
|
It considers PATCH to be optional and permits the 4th Revision component.
|
|
2496
2868
|
</summary>
|
|
2497
2869
|
<remarks>
|
|
2498
|
-
Parts of this regex inspired by https://github.com/sindresorhus/semver-regex/blob/master/index.js
|
|
2870
|
+
Parts of this regex inspired by <see href="https://github.com/sindresorhus/semver-regex/blob/master/index.js">this code</see>.
|
|
2499
2871
|
</remarks>
|
|
2500
2872
|
</member>
|
|
2501
2873
|
<member name="F:Nerdbank.GitVersioning.SemanticVersion.PrereleasePattern">
|
|
@@ -2617,7 +2989,7 @@
|
|
|
2617
2989
|
</summary>
|
|
2618
2990
|
<param name="semanticVersion">The value which must wholly constitute a semantic version to succeed.</param>
|
|
2619
2991
|
<param name="version">Receives the semantic version, if found.</param>
|
|
2620
|
-
<returns><
|
|
2992
|
+
<returns><see langword="true"/> if a semantic version is found; <see langword="false"/> otherwise.</returns>
|
|
2621
2993
|
</member>
|
|
2622
2994
|
<member name="M:Nerdbank.GitVersioning.SemanticVersion.Parse(System.String)">
|
|
2623
2995
|
<summary>
|
|
@@ -2631,7 +3003,7 @@
|
|
|
2631
3003
|
Checks equality against another object.
|
|
2632
3004
|
</summary>
|
|
2633
3005
|
<param name="obj">The other instance.</param>
|
|
2634
|
-
<returns><
|
|
3006
|
+
<returns><see langword="true"/> if the instances have equal values; <see langword="false"/> otherwise.</returns>
|
|
2635
3007
|
</member>
|
|
2636
3008
|
<member name="M:Nerdbank.GitVersioning.SemanticVersion.GetHashCode">
|
|
2637
3009
|
<summary>
|
|
@@ -2650,7 +3022,7 @@
|
|
|
2650
3022
|
Checks equality against another instance of this class.
|
|
2651
3023
|
</summary>
|
|
2652
3024
|
<param name="other">The other instance.</param>
|
|
2653
|
-
<returns><
|
|
3025
|
+
<returns><see langword="true"/> if the instances have equal values; <see langword="false"/> otherwise.</returns>
|
|
2654
3026
|
</member>
|
|
2655
3027
|
<member name="M:Nerdbank.GitVersioning.SemanticVersion.WillVersionChangeResetVersionHeight(Nerdbank.GitVersioning.SemanticVersion,Nerdbank.GitVersioning.SemanticVersion,Nerdbank.GitVersioning.SemanticVersion.Position)">
|
|
2656
3028
|
<summary>
|
|
@@ -2660,7 +3032,7 @@
|
|
|
2660
3032
|
<param name="first">The first semantic version.</param>
|
|
2661
3033
|
<param name="second">The second semantic version.</param>
|
|
2662
3034
|
<param name="versionHeightPosition">The position within the version where height is tracked.</param>
|
|
2663
|
-
<returns><
|
|
3035
|
+
<returns><see langword="true"/> if transitioning from one version to the next should reset the version height; <see langword="false"/> otherwise.</returns>
|
|
2664
3036
|
</member>
|
|
2665
3037
|
<member name="M:Nerdbank.GitVersioning.SemanticVersion.IsMatchingVersion(System.Version)">
|
|
2666
3038
|
<summary>
|
|
@@ -2675,7 +3047,7 @@
|
|
|
2675
3047
|
belongs to the set of versions represented by this semantic version spec.
|
|
2676
3048
|
</summary>
|
|
2677
3049
|
<param name="version">A version, with major and minor components, and possibly build and/or revision components.</param>
|
|
2678
|
-
<returns><
|
|
3050
|
+
<returns><see langword="true"/> if <paramref name="version"/> may have been produced by this semantic version; <see langword="false"/> otherwise.</returns>
|
|
2679
3051
|
</member>
|
|
2680
3052
|
<member name="M:Nerdbank.GitVersioning.SemanticVersion.VerifyPatternMatch(System.String,System.Text.RegularExpressions.Regex,System.String)">
|
|
2681
3053
|
<summary>
|
|
@@ -2688,6 +3060,15 @@
|
|
|
2688
3060
|
Thrown if the <paramref name="input"/> does not match the required <paramref name="pattern"/>.
|
|
2689
3061
|
</exception>
|
|
2690
3062
|
</member>
|
|
3063
|
+
<member name="M:Nerdbank.GitVersioning.SemanticVersionJsonConverter.CanConvert(System.Type)">
|
|
3064
|
+
<inheritdoc/>
|
|
3065
|
+
</member>
|
|
3066
|
+
<member name="M:Nerdbank.GitVersioning.SemanticVersionJsonConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
|
|
3067
|
+
<inheritdoc/>
|
|
3068
|
+
</member>
|
|
3069
|
+
<member name="M:Nerdbank.GitVersioning.SemanticVersionJsonConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
|
|
3070
|
+
<inheritdoc/>
|
|
3071
|
+
</member>
|
|
2691
3072
|
<member name="T:Nerdbank.GitVersioning.VersionExtensions">
|
|
2692
3073
|
<summary>
|
|
2693
3074
|
Extension methods for the <see cref="T:System.Version"/> class.
|
|
@@ -2731,7 +3112,7 @@
|
|
|
2731
3112
|
<param name="minor">The minor version.</param>
|
|
2732
3113
|
<param name="build">The build version.</param>
|
|
2733
3114
|
<param name="revision">The revision.</param>
|
|
2734
|
-
<returns
|
|
3115
|
+
<returns>The newly created <see cref="T:System.Version"/>.</returns>
|
|
2735
3116
|
</member>
|
|
2736
3117
|
<member name="T:Nerdbank.GitVersioning.VersionFile">
|
|
2737
3118
|
<summary>
|
|
@@ -2763,7 +3144,7 @@
|
|
|
2763
3144
|
<summary>
|
|
2764
3145
|
Checks whether a version file is defined.
|
|
2765
3146
|
</summary>
|
|
2766
|
-
<returns><
|
|
3147
|
+
<returns><see langword="true"/> if the version file is found; otherwise <see langword="false"/>.</returns>
|
|
2767
3148
|
</member>
|
|
2768
3149
|
<member name="M:Nerdbank.GitVersioning.VersionFile.GetWorkingCopyVersion">
|
|
2769
3150
|
<inheritdoc cref="M:Nerdbank.GitVersioning.VersionFile.GetWorkingCopyVersion(System.String@)"/>
|
|
@@ -2773,7 +3154,7 @@
|
|
|
2773
3154
|
Reads the version file from the working tree and returns the <see cref="T:Nerdbank.GitVersioning.VersionOptions"/> deserialized from it.
|
|
2774
3155
|
</summary>
|
|
2775
3156
|
<param name="actualDirectory">Set to the actual directory that the version file was found in, which may be <see cref="P:Nerdbank.GitVersioning.GitContext.WorkingTreePath"/> or one of its ancestors.</param>
|
|
2776
|
-
<returns>The version information read from the file, or <
|
|
3157
|
+
<returns>The version information read from the file, or <see langword="null"/> if the file wasn't found.</returns>
|
|
2777
3158
|
</member>
|
|
2778
3159
|
<member name="M:Nerdbank.GitVersioning.VersionFile.SetVersion(System.String,System.Version,System.String,System.Boolean)">
|
|
2779
3160
|
<inheritdoc cref="M:Nerdbank.GitVersioning.VersionFile.SetVersion(System.String,Nerdbank.GitVersioning.VersionOptions,System.Boolean)"/>
|
|
@@ -2792,14 +3173,6 @@
|
|
|
2792
3173
|
<param name="includeSchemaProperty">A value indicating whether to serialize the $schema property for easier editing in most JSON editors.</param>
|
|
2793
3174
|
<returns>The path to the file written.</returns>
|
|
2794
3175
|
</member>
|
|
2795
|
-
<member name="M:Nerdbank.GitVersioning.VersionFile.GetVersionCore(System.String@)">
|
|
2796
|
-
<summary>
|
|
2797
|
-
Reads the version file from <see cref="P:Nerdbank.GitVersioning.GitContext.GitCommitId"/> in the <see cref="P:Nerdbank.GitVersioning.VersionFile.Context"/> and returns the <see cref="T:Nerdbank.GitVersioning.VersionOptions"/> deserialized from it.
|
|
2798
|
-
</summary>
|
|
2799
|
-
<param name="actualDirectory">Receives the absolute path to the directory where the version file was found, if any.</param>
|
|
2800
|
-
<returns>The version information read from the file, or <see langword="null"/> if the file wasn't found.</returns>
|
|
2801
|
-
<remarks>This method is only called if <see cref="P:Nerdbank.GitVersioning.GitContext.GitCommitId"/> is not null.</remarks>
|
|
2802
|
-
</member>
|
|
2803
3176
|
<member name="M:Nerdbank.GitVersioning.VersionFile.GetVersion">
|
|
2804
3177
|
<inheritdoc cref="M:Nerdbank.GitVersioning.VersionFile.GetVersion(System.String@)"/>
|
|
2805
3178
|
</member>
|
|
@@ -2823,7 +3196,15 @@
|
|
|
2823
3196
|
Reads the version.txt file and returns the <see cref="T:System.Version"/> and prerelease tag from it.
|
|
2824
3197
|
</summary>
|
|
2825
3198
|
<param name="versionTextContent">The content of the version.txt file to read.</param>
|
|
2826
|
-
<returns>The version information read from the file; or <
|
|
3199
|
+
<returns>The version information read from the file; or <see langword="null"/> if a deserialization error occurs.</returns>
|
|
3200
|
+
</member>
|
|
3201
|
+
<member name="M:Nerdbank.GitVersioning.VersionFile.GetVersionCore(System.String@)">
|
|
3202
|
+
<summary>
|
|
3203
|
+
Reads the version file from <see cref="P:Nerdbank.GitVersioning.GitContext.GitCommitId"/> in the <see cref="P:Nerdbank.GitVersioning.VersionFile.Context"/> and returns the <see cref="T:Nerdbank.GitVersioning.VersionOptions"/> deserialized from it.
|
|
3204
|
+
</summary>
|
|
3205
|
+
<param name="actualDirectory">Receives the absolute path to the directory where the version file was found, if any.</param>
|
|
3206
|
+
<returns>The version information read from the file, or <see langword="null"/> if the file wasn't found.</returns>
|
|
3207
|
+
<remarks>This method is only called if <see cref="P:Nerdbank.GitVersioning.GitContext.GitCommitId"/> is not null.</remarks>
|
|
2827
3208
|
</member>
|
|
2828
3209
|
<member name="M:Nerdbank.GitVersioning.VersionFile.GetWorkingCopyVersion(System.String,System.String@)">
|
|
2829
3210
|
<summary>
|
|
@@ -2838,6 +3219,31 @@
|
|
|
2838
3219
|
Describes the various versions and options required for the build.
|
|
2839
3220
|
</summary>
|
|
2840
3221
|
</member>
|
|
3222
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.DefaultVersionPrecision">
|
|
3223
|
+
<summary>
|
|
3224
|
+
Default value for <see cref="T:Nerdbank.GitVersioning.VersionOptions.VersionPrecision"/>.
|
|
3225
|
+
</summary>
|
|
3226
|
+
</member>
|
|
3227
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.VersionHeightPlaceholder">
|
|
3228
|
+
<summary>
|
|
3229
|
+
The placeholder that may appear in the <see cref="P:Nerdbank.GitVersioning.VersionOptions.Version"/> property's <see cref="P:Nerdbank.GitVersioning.SemanticVersion.Prerelease"/>
|
|
3230
|
+
to specify where the version height should appear in a computed semantic version.
|
|
3231
|
+
</summary>
|
|
3232
|
+
<remarks>
|
|
3233
|
+
When this macro does not appear in the string, the version height is set as the first unspecified integer of the 4-integer version.
|
|
3234
|
+
If all 4 integers in a version are specified, and the macro does not appear, the version height isn't inserted anywhere.
|
|
3235
|
+
</remarks>
|
|
3236
|
+
</member>
|
|
3237
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.DefaultGitCommitIdShortFixedLength">
|
|
3238
|
+
<summary>
|
|
3239
|
+
The default value for the <see cref="P:Nerdbank.GitVersioning.VersionOptions.GitCommitIdShortFixedLength"/> property.
|
|
3240
|
+
</summary>
|
|
3241
|
+
</member>
|
|
3242
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.DefaultSemVer1NumericIdentifierPadding">
|
|
3243
|
+
<summary>
|
|
3244
|
+
The default value for the <see cref="P:Nerdbank.GitVersioning.VersionOptions.SemVer1NumericIdentifierPaddingOrDefault"/> property.
|
|
3245
|
+
</summary>
|
|
3246
|
+
</member>
|
|
2841
3247
|
<member name="F:Nerdbank.GitVersioning.VersionOptions.isFrozen">
|
|
2842
3248
|
<summary>
|
|
2843
3249
|
A value indicating whether mutations of this instance are not allowed.
|
|
@@ -2860,89 +3266,144 @@
|
|
|
2860
3266
|
</member>
|
|
2861
3267
|
<member name="F:Nerdbank.GitVersioning.VersionOptions.semVer1NumericIdentifierPadding">
|
|
2862
3268
|
<summary>
|
|
2863
|
-
Backing field for the <see cref="P:Nerdbank.GitVersioning.VersionOptions.SemVer1NumericIdentifierPadding"/> property.
|
|
3269
|
+
Backing field for the <see cref="P:Nerdbank.GitVersioning.VersionOptions.SemVer1NumericIdentifierPadding"/> property.
|
|
3270
|
+
</summary>
|
|
3271
|
+
</member>
|
|
3272
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.gitCommitIdShortFixedLength">
|
|
3273
|
+
<summary>
|
|
3274
|
+
Backing field for the <see cref="P:Nerdbank.GitVersioning.VersionOptions.GitCommitIdShortFixedLength"/> property.
|
|
3275
|
+
</summary>
|
|
3276
|
+
</member>
|
|
3277
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.gitCommitIdShortAutoMinimum">
|
|
3278
|
+
<summary>
|
|
3279
|
+
Backing field for the <see cref="P:Nerdbank.GitVersioning.VersionOptions.GitCommitIdShortAutoMinimum"/> property.
|
|
3280
|
+
</summary>
|
|
3281
|
+
</member>
|
|
3282
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.nuGetPackageVersion">
|
|
3283
|
+
<summary>
|
|
3284
|
+
Backing field for the <see cref="P:Nerdbank.GitVersioning.VersionOptions.NuGetPackageVersion"/> property.
|
|
3285
|
+
</summary>
|
|
3286
|
+
</member>
|
|
3287
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.publicReleaseRefSpec">
|
|
3288
|
+
<summary>
|
|
3289
|
+
Backing field for the <see cref="P:Nerdbank.GitVersioning.VersionOptions.PublicReleaseRefSpec"/> property.
|
|
3290
|
+
</summary>
|
|
3291
|
+
</member>
|
|
3292
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.cloudBuild">
|
|
3293
|
+
<summary>
|
|
3294
|
+
Backing field for the <see cref="P:Nerdbank.GitVersioning.VersionOptions.CloudBuild"/> property.
|
|
3295
|
+
</summary>
|
|
3296
|
+
</member>
|
|
3297
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.release">
|
|
3298
|
+
<summary>
|
|
3299
|
+
Backing field for the <see cref="P:Nerdbank.GitVersioning.VersionOptions.Release"/> property.
|
|
3300
|
+
</summary>
|
|
3301
|
+
</member>
|
|
3302
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.pathFilters">
|
|
3303
|
+
<summary>
|
|
3304
|
+
Backing field for the <see cref="P:Nerdbank.GitVersioning.VersionOptions.PathFilters"/> property.
|
|
3305
|
+
</summary>
|
|
3306
|
+
</member>
|
|
3307
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.inherit">
|
|
3308
|
+
<summary>
|
|
3309
|
+
Backing field for the <see cref="P:Nerdbank.GitVersioning.VersionOptions.Inherit"/> property.
|
|
3310
|
+
</summary>
|
|
3311
|
+
</member>
|
|
3312
|
+
<member name="M:Nerdbank.GitVersioning.VersionOptions.#ctor">
|
|
3313
|
+
<summary>
|
|
3314
|
+
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.VersionOptions"/> class.
|
|
3315
|
+
</summary>
|
|
3316
|
+
</member>
|
|
3317
|
+
<member name="M:Nerdbank.GitVersioning.VersionOptions.#ctor(Nerdbank.GitVersioning.VersionOptions)">
|
|
3318
|
+
<summary>
|
|
3319
|
+
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.VersionOptions"/> class.
|
|
3320
|
+
</summary>
|
|
3321
|
+
<param name="copyFrom">Another instance to copy values from.</param>
|
|
3322
|
+
</member>
|
|
3323
|
+
<member name="T:Nerdbank.GitVersioning.VersionOptions.VersionPrecision">
|
|
3324
|
+
<summary>
|
|
3325
|
+
The last component to control in a 4 integer version.
|
|
3326
|
+
</summary>
|
|
3327
|
+
</member>
|
|
3328
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.VersionPrecision.Major">
|
|
3329
|
+
<summary>
|
|
3330
|
+
The first integer is the last number set. The rest will be zeros.
|
|
2864
3331
|
</summary>
|
|
2865
3332
|
</member>
|
|
2866
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.
|
|
3333
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.VersionPrecision.Minor">
|
|
2867
3334
|
<summary>
|
|
2868
|
-
|
|
3335
|
+
The second integer is the last number set. The rest will be zeros.
|
|
2869
3336
|
</summary>
|
|
2870
3337
|
</member>
|
|
2871
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.
|
|
3338
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.VersionPrecision.Build">
|
|
2872
3339
|
<summary>
|
|
2873
|
-
|
|
3340
|
+
The third integer is the last number set. The fourth will be zero.
|
|
2874
3341
|
</summary>
|
|
2875
3342
|
</member>
|
|
2876
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.
|
|
3343
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.VersionPrecision.Revision">
|
|
2877
3344
|
<summary>
|
|
2878
|
-
|
|
3345
|
+
All four integers will be set.
|
|
2879
3346
|
</summary>
|
|
2880
3347
|
</member>
|
|
2881
|
-
<member name="
|
|
3348
|
+
<member name="T:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitWhen">
|
|
2882
3349
|
<summary>
|
|
2883
|
-
|
|
3350
|
+
The conditions a commit ID is included in a cloud build number.
|
|
2884
3351
|
</summary>
|
|
2885
3352
|
</member>
|
|
2886
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.
|
|
3353
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitWhen.Always">
|
|
2887
3354
|
<summary>
|
|
2888
|
-
|
|
3355
|
+
Always include the commit information in the cloud Build Number.
|
|
2889
3356
|
</summary>
|
|
2890
3357
|
</member>
|
|
2891
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.
|
|
3358
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitWhen.NonPublicReleaseOnly">
|
|
2892
3359
|
<summary>
|
|
2893
|
-
|
|
3360
|
+
Only include the commit information when building a non-PublicRelease.
|
|
2894
3361
|
</summary>
|
|
2895
3362
|
</member>
|
|
2896
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.
|
|
3363
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitWhen.Never">
|
|
2897
3364
|
<summary>
|
|
2898
|
-
|
|
3365
|
+
Never include the commit information.
|
|
2899
3366
|
</summary>
|
|
2900
3367
|
</member>
|
|
2901
|
-
<member name="
|
|
3368
|
+
<member name="T:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitWhere">
|
|
2902
3369
|
<summary>
|
|
2903
|
-
|
|
3370
|
+
The position a commit ID can appear in a cloud build number.
|
|
2904
3371
|
</summary>
|
|
2905
3372
|
</member>
|
|
2906
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.
|
|
3373
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitWhere.BuildMetadata">
|
|
2907
3374
|
<summary>
|
|
2908
|
-
|
|
3375
|
+
The commit ID appears in build metadata (e.g. +ga1b2c3).
|
|
2909
3376
|
</summary>
|
|
2910
3377
|
</member>
|
|
2911
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.
|
|
3378
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitWhere.FourthVersionComponent">
|
|
2912
3379
|
<summary>
|
|
2913
|
-
The
|
|
2914
|
-
to specify where the version height should appear in a computed semantic version.
|
|
3380
|
+
The commit ID appears as the 4th integer in the version (e.g. 1.2.3.23523).
|
|
2915
3381
|
</summary>
|
|
2916
|
-
<remarks>
|
|
2917
|
-
When this macro does not appear in the string, the version height is set as the first unspecified integer of the 4-integer version.
|
|
2918
|
-
If all 4 integers in a version are specified, and the macro does not appear, the version height isn't inserted anywhere.
|
|
2919
|
-
</remarks>
|
|
2920
3382
|
</member>
|
|
2921
|
-
<member name="
|
|
3383
|
+
<member name="T:Nerdbank.GitVersioning.VersionOptions.ReleaseVersionIncrement">
|
|
2922
3384
|
<summary>
|
|
2923
|
-
|
|
3385
|
+
Possible increments of the version after creating release branches.
|
|
2924
3386
|
</summary>
|
|
2925
3387
|
</member>
|
|
2926
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.
|
|
3388
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.ReleaseVersionIncrement.Major">
|
|
2927
3389
|
<summary>
|
|
2928
|
-
|
|
3390
|
+
Increment the major version after creating a release branch.
|
|
2929
3391
|
</summary>
|
|
2930
3392
|
</member>
|
|
2931
|
-
<member name="
|
|
3393
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.ReleaseVersionIncrement.Minor">
|
|
2932
3394
|
<summary>
|
|
2933
|
-
|
|
3395
|
+
Increment the minor version after creating a release branch.
|
|
2934
3396
|
</summary>
|
|
2935
3397
|
</member>
|
|
2936
|
-
<member name="
|
|
3398
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.ReleaseVersionIncrement.Build">
|
|
2937
3399
|
<summary>
|
|
2938
|
-
|
|
3400
|
+
Increment the build number (the third number in a version) after creating a release branch.
|
|
2939
3401
|
</summary>
|
|
2940
3402
|
</member>
|
|
2941
|
-
<member name="
|
|
3403
|
+
<member name="P:Nerdbank.GitVersioning.VersionOptions.Schema">
|
|
2942
3404
|
<summary>
|
|
2943
|
-
|
|
3405
|
+
Gets the $schema field that should be serialized when writing.
|
|
2944
3406
|
</summary>
|
|
2945
|
-
<param name="copyFrom">Another instance to copy values from.</param>
|
|
2946
3407
|
</member>
|
|
2947
3408
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.Version">
|
|
2948
3409
|
<summary>
|
|
@@ -2954,13 +3415,13 @@
|
|
|
2954
3415
|
Gets or sets the version to use particularly for the <see cref="T:System.Reflection.AssemblyVersionAttribute"/>
|
|
2955
3416
|
instead of the default <see cref="P:Nerdbank.GitVersioning.VersionOptions.Version"/>.
|
|
2956
3417
|
</summary>
|
|
2957
|
-
<value>An instance of <see cref="T:System.Version"/> or <
|
|
3418
|
+
<value>An instance of <see cref="T:System.Version"/> or <see langword="null"/> to simply use the default <see cref="P:Nerdbank.GitVersioning.VersionOptions.Version"/>.</value>
|
|
2958
3419
|
</member>
|
|
2959
3420
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.GitCommitIdPrefix">
|
|
2960
3421
|
<summary>
|
|
2961
3422
|
Gets or sets the prefix for git commit id in version.
|
|
2962
3423
|
Because of semver rules the prefix must lead with a [A-z_] character (not a number) and it cannot be the empty string.
|
|
2963
|
-
If <
|
|
3424
|
+
If <see langword="null"/> 'g' will be used.
|
|
2964
3425
|
</summary>
|
|
2965
3426
|
<value>A prefix for git commit id.</value>
|
|
2966
3427
|
</member>
|
|
@@ -2969,7 +3430,7 @@
|
|
|
2969
3430
|
Gets the version to use particularly for the <see cref="T:System.Reflection.AssemblyVersionAttribute"/>
|
|
2970
3431
|
instead of the default <see cref="P:Nerdbank.GitVersioning.VersionOptions.Version"/>.
|
|
2971
3432
|
</summary>
|
|
2972
|
-
<value>An instance of <see cref="T:System.Version"/> or <
|
|
3433
|
+
<value>An instance of <see cref="T:System.Version"/> or <see langword="null"/> to simply use the default <see cref="P:Nerdbank.GitVersioning.VersionOptions.Version"/>.</value>
|
|
2973
3434
|
</member>
|
|
2974
3435
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.BuildNumberOffset">
|
|
2975
3436
|
<summary>
|
|
@@ -3037,12 +3498,12 @@
|
|
|
3037
3498
|
</member>
|
|
3038
3499
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.NuGetPackageVersion">
|
|
3039
3500
|
<summary>
|
|
3040
|
-
Gets or sets the options around NuGet version strings
|
|
3501
|
+
Gets or sets the options around NuGet version strings.
|
|
3041
3502
|
</summary>
|
|
3042
3503
|
</member>
|
|
3043
3504
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.NuGetPackageVersionOrDefault">
|
|
3044
3505
|
<summary>
|
|
3045
|
-
Gets the options around NuGet version strings
|
|
3506
|
+
Gets the options around NuGet version strings.
|
|
3046
3507
|
</summary>
|
|
3047
3508
|
</member>
|
|
3048
3509
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.PublicReleaseRefSpec">
|
|
@@ -3069,12 +3530,12 @@
|
|
|
3069
3530
|
</member>
|
|
3070
3531
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.Release">
|
|
3071
3532
|
<summary>
|
|
3072
|
-
Gets or sets the options for the prepare-release command
|
|
3533
|
+
Gets or sets the options for the prepare-release command.
|
|
3073
3534
|
</summary>
|
|
3074
3535
|
</member>
|
|
3075
3536
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.ReleaseOrDefault">
|
|
3076
3537
|
<summary>
|
|
3077
|
-
Gets the options for the prepare-release command
|
|
3538
|
+
Gets the options for the prepare-release command.
|
|
3078
3539
|
</summary>
|
|
3079
3540
|
</member>
|
|
3080
3541
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.PathFilters">
|
|
@@ -3089,7 +3550,7 @@
|
|
|
3089
3550
|
Gets or sets a value indicating whether this options object should inherit from an ancestor any settings that are not explicitly set in this one.
|
|
3090
3551
|
</summary>
|
|
3091
3552
|
<remarks>
|
|
3092
|
-
When this is <
|
|
3553
|
+
When this is <see langword="true"/>, this object may not completely describe the options to be applied.
|
|
3093
3554
|
</remarks>
|
|
3094
3555
|
</member>
|
|
3095
3556
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.IsFrozen">
|
|
@@ -3107,6 +3568,12 @@
|
|
|
3107
3568
|
Gets the position in a computed version that the first 16 bits of a git commit ID should appear, if any.
|
|
3108
3569
|
</summary>
|
|
3109
3570
|
</member>
|
|
3571
|
+
<member name="P:Nerdbank.GitVersioning.VersionOptions.IsDefaultVersionTheOnlyPropertySet">
|
|
3572
|
+
<summary>
|
|
3573
|
+
Gets a value indicating whether <see cref="P:Nerdbank.GitVersioning.VersionOptions.Version"/> is
|
|
3574
|
+
set and the only property on this class that is set.
|
|
3575
|
+
</summary>
|
|
3576
|
+
</member>
|
|
3110
3577
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.DebuggerDisplay">
|
|
3111
3578
|
<summary>
|
|
3112
3579
|
Gets the debugger display for this instance.
|
|
@@ -3149,7 +3616,7 @@
|
|
|
3149
3616
|
filters should be relative to.
|
|
3150
3617
|
This should be the directory where the version.json file resides.
|
|
3151
3618
|
An empty string represents the root of the repository.
|
|
3152
|
-
Passing <
|
|
3619
|
+
Passing <see langword="null"/> will mean path filters cannot be serialized.
|
|
3153
3620
|
</param>
|
|
3154
3621
|
<returns>The serializer settings to use.</returns>
|
|
3155
3622
|
</member>
|
|
@@ -3158,7 +3625,7 @@
|
|
|
3158
3625
|
Checks equality against another object.
|
|
3159
3626
|
</summary>
|
|
3160
3627
|
<param name="obj">The other instance.</param>
|
|
3161
|
-
<returns><
|
|
3628
|
+
<returns><see langword="true"/> if the instances have equal values; <see langword="false"/> otherwise.</returns>
|
|
3162
3629
|
</member>
|
|
3163
3630
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.GetHashCode">
|
|
3164
3631
|
<summary>
|
|
@@ -3171,19 +3638,13 @@
|
|
|
3171
3638
|
Checks equality against another instance of this class.
|
|
3172
3639
|
</summary>
|
|
3173
3640
|
<param name="other">The other instance.</param>
|
|
3174
|
-
<returns><
|
|
3641
|
+
<returns><see langword="true"/> if the instances have equal values; <see langword="false"/> otherwise.</returns>
|
|
3175
3642
|
</member>
|
|
3176
3643
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.Freeze">
|
|
3177
3644
|
<summary>
|
|
3178
3645
|
Freezes this instance so no more changes can be made to it.
|
|
3179
3646
|
</summary>
|
|
3180
3647
|
</member>
|
|
3181
|
-
<member name="P:Nerdbank.GitVersioning.VersionOptions.IsDefaultVersionTheOnlyPropertySet">
|
|
3182
|
-
<summary>
|
|
3183
|
-
Gets a value indicating whether <see cref="P:Nerdbank.GitVersioning.VersionOptions.Version"/> is
|
|
3184
|
-
set and the only property on this class that is set.
|
|
3185
|
-
</summary>
|
|
3186
|
-
</member>
|
|
3187
3648
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.SetIfNotReadOnly``1(``0@,``0)">
|
|
3188
3649
|
<summary>
|
|
3189
3650
|
Sets the value of a field if this instance is not marked as read only.
|
|
@@ -3197,14 +3658,14 @@
|
|
|
3197
3658
|
The class that contains settings for the <see cref="P:Nerdbank.GitVersioning.VersionOptions.NuGetPackageVersion" /> property.
|
|
3198
3659
|
</summary>
|
|
3199
3660
|
</member>
|
|
3200
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.NuGetPackageVersionOptions.
|
|
3661
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.NuGetPackageVersionOptions.DefaultPrecision">
|
|
3201
3662
|
<summary>
|
|
3202
|
-
|
|
3663
|
+
Default value for <see cref="P:Nerdbank.GitVersioning.VersionOptions.NuGetPackageVersionOptions.Precision"/>.
|
|
3203
3664
|
</summary>
|
|
3204
3665
|
</member>
|
|
3205
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.NuGetPackageVersionOptions.
|
|
3666
|
+
<member name="F:Nerdbank.GitVersioning.VersionOptions.NuGetPackageVersionOptions.DefaultInstance">
|
|
3206
3667
|
<summary>
|
|
3207
|
-
|
|
3668
|
+
The default (uninitialized) instance.
|
|
3208
3669
|
</summary>
|
|
3209
3670
|
</member>
|
|
3210
3671
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.NuGetPackageVersionOptions.#ctor">
|
|
@@ -3216,6 +3677,7 @@
|
|
|
3216
3677
|
<summary>
|
|
3217
3678
|
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.VersionOptions.NuGetPackageVersionOptions" /> class.
|
|
3218
3679
|
</summary>
|
|
3680
|
+
<param name="copyFrom">The existing instance to copy from.</param>
|
|
3219
3681
|
</member>
|
|
3220
3682
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.NuGetPackageVersionOptions.SemVer">
|
|
3221
3683
|
<summary>
|
|
@@ -3242,6 +3704,11 @@
|
|
|
3242
3704
|
Gets a value indicating whether this instance rejects all attempts to mutate it.
|
|
3243
3705
|
</summary>
|
|
3244
3706
|
</member>
|
|
3707
|
+
<member name="P:Nerdbank.GitVersioning.VersionOptions.NuGetPackageVersionOptions.IsDefault">
|
|
3708
|
+
<summary>
|
|
3709
|
+
Gets a value indicating whether this instance is equivalent to the default instance.
|
|
3710
|
+
</summary>
|
|
3711
|
+
</member>
|
|
3245
3712
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.NuGetPackageVersionOptions.Freeze">
|
|
3246
3713
|
<summary>
|
|
3247
3714
|
Freezes this instance so no more changes can be made to it.
|
|
@@ -3256,11 +3723,6 @@
|
|
|
3256
3723
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.NuGetPackageVersionOptions.GetHashCode">
|
|
3257
3724
|
<inheritdoc />
|
|
3258
3725
|
</member>
|
|
3259
|
-
<member name="P:Nerdbank.GitVersioning.VersionOptions.NuGetPackageVersionOptions.IsDefault">
|
|
3260
|
-
<summary>
|
|
3261
|
-
Gets a value indicating whether this instance is equivalent to the default instance.
|
|
3262
|
-
</summary>
|
|
3263
|
-
</member>
|
|
3264
3726
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.NuGetPackageVersionOptions.SetIfNotReadOnly``1(``0@,``0)">
|
|
3265
3727
|
<summary>
|
|
3266
3728
|
Sets the value of a field if this instance is not marked as read only.
|
|
@@ -3301,6 +3763,7 @@
|
|
|
3301
3763
|
<summary>
|
|
3302
3764
|
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.VersionOptions.AssemblyVersionOptions"/> class.
|
|
3303
3765
|
</summary>
|
|
3766
|
+
<param name="copyFrom">The existing instance to copy from.</param>
|
|
3304
3767
|
</member>
|
|
3305
3768
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.AssemblyVersionOptions.Version">
|
|
3306
3769
|
<summary>
|
|
@@ -3322,6 +3785,11 @@
|
|
|
3322
3785
|
Gets a value indicating whether this instance rejects all attempts to mutate it.
|
|
3323
3786
|
</summary>
|
|
3324
3787
|
</member>
|
|
3788
|
+
<member name="P:Nerdbank.GitVersioning.VersionOptions.AssemblyVersionOptions.IsDefault">
|
|
3789
|
+
<summary>
|
|
3790
|
+
Gets a value indicating whether this instance is equivalent to the default instance.
|
|
3791
|
+
</summary>
|
|
3792
|
+
</member>
|
|
3325
3793
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.AssemblyVersionOptions.Freeze">
|
|
3326
3794
|
<summary>
|
|
3327
3795
|
Freezes this instance so no more changes can be made to it.
|
|
@@ -3336,11 +3804,6 @@
|
|
|
3336
3804
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.AssemblyVersionOptions.GetHashCode">
|
|
3337
3805
|
<inheritdoc />
|
|
3338
3806
|
</member>
|
|
3339
|
-
<member name="P:Nerdbank.GitVersioning.VersionOptions.AssemblyVersionOptions.IsDefault">
|
|
3340
|
-
<summary>
|
|
3341
|
-
Gets a value indicating whether this instance is equivalent to the default instance.
|
|
3342
|
-
</summary>
|
|
3343
|
-
</member>
|
|
3344
3807
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.AssemblyVersionOptions.SetIfNotReadOnly``1(``0@,``0)">
|
|
3345
3808
|
<summary>
|
|
3346
3809
|
Sets the value of a field if this instance is not marked as read only.
|
|
@@ -3357,7 +3820,7 @@
|
|
|
3357
3820
|
</member>
|
|
3358
3821
|
<member name="T:Nerdbank.GitVersioning.VersionOptions.CloudBuildOptions">
|
|
3359
3822
|
<summary>
|
|
3360
|
-
Options that are applicable specifically to cloud builds (e.g. VSTS, AppVeyor, TeamCity)
|
|
3823
|
+
Options that are applicable specifically to cloud builds (e.g. VSTS, AppVeyor, TeamCity).
|
|
3361
3824
|
</summary>
|
|
3362
3825
|
</member>
|
|
3363
3826
|
<member name="F:Nerdbank.GitVersioning.VersionOptions.CloudBuildOptions.DefaultInstance">
|
|
@@ -3374,7 +3837,7 @@
|
|
|
3374
3837
|
<summary>
|
|
3375
3838
|
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.VersionOptions.CloudBuildOptions"/> class.
|
|
3376
3839
|
</summary>
|
|
3377
|
-
<param name="copyFrom">Another instance to copy values from
|
|
3840
|
+
<param name="copyFrom">Another instance to copy values from.</param>
|
|
3378
3841
|
</member>
|
|
3379
3842
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.CloudBuildOptions.SetAllVariables">
|
|
3380
3843
|
<summary>
|
|
@@ -3411,6 +3874,11 @@
|
|
|
3411
3874
|
Gets a value indicating whether this instance rejects all attempts to mutate it.
|
|
3412
3875
|
</summary>
|
|
3413
3876
|
</member>
|
|
3877
|
+
<member name="P:Nerdbank.GitVersioning.VersionOptions.CloudBuildOptions.IsDefault">
|
|
3878
|
+
<summary>
|
|
3879
|
+
Gets a value indicating whether this instance is equivalent to the default instance.
|
|
3880
|
+
</summary>
|
|
3881
|
+
</member>
|
|
3414
3882
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.CloudBuildOptions.Freeze">
|
|
3415
3883
|
<summary>
|
|
3416
3884
|
Freezes this instance so no more changes can be made to it.
|
|
@@ -3425,11 +3893,6 @@
|
|
|
3425
3893
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.CloudBuildOptions.GetHashCode">
|
|
3426
3894
|
<inheritdoc />
|
|
3427
3895
|
</member>
|
|
3428
|
-
<member name="P:Nerdbank.GitVersioning.VersionOptions.CloudBuildOptions.IsDefault">
|
|
3429
|
-
<summary>
|
|
3430
|
-
Gets a value indicating whether this instance is equivalent to the default instance.
|
|
3431
|
-
</summary>
|
|
3432
|
-
</member>
|
|
3433
3896
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.CloudBuildOptions.SetIfNotReadOnly``1(``0@,``0)">
|
|
3434
3897
|
<summary>
|
|
3435
3898
|
Sets the value of a field if this instance is not marked as read only.
|
|
@@ -3463,6 +3926,7 @@
|
|
|
3463
3926
|
<summary>
|
|
3464
3927
|
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberOptions"/> class.
|
|
3465
3928
|
</summary>
|
|
3929
|
+
<param name="copyFrom">The existing instance to copy from.</param>
|
|
3466
3930
|
</member>
|
|
3467
3931
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberOptions.Enabled">
|
|
3468
3932
|
<summary>
|
|
@@ -3489,6 +3953,11 @@
|
|
|
3489
3953
|
Gets a value indicating whether this instance rejects all attempts to mutate it.
|
|
3490
3954
|
</summary>
|
|
3491
3955
|
</member>
|
|
3956
|
+
<member name="P:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberOptions.IsDefault">
|
|
3957
|
+
<summary>
|
|
3958
|
+
Gets a value indicating whether this instance is equivalent to the default instance.
|
|
3959
|
+
</summary>
|
|
3960
|
+
</member>
|
|
3492
3961
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberOptions.Freeze">
|
|
3493
3962
|
<summary>
|
|
3494
3963
|
Freezes this instance so no more changes can be made to it.
|
|
@@ -3503,11 +3972,6 @@
|
|
|
3503
3972
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberOptions.GetHashCode">
|
|
3504
3973
|
<inheritdoc />
|
|
3505
3974
|
</member>
|
|
3506
|
-
<member name="P:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberOptions.IsDefault">
|
|
3507
|
-
<summary>
|
|
3508
|
-
Gets a value indicating whether this instance is equivalent to the default instance.
|
|
3509
|
-
</summary>
|
|
3510
|
-
</member>
|
|
3511
3975
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberOptions.SetIfNotReadOnly``1(``0@,``0)">
|
|
3512
3976
|
<summary>
|
|
3513
3977
|
Sets the value of a field if this instance is not marked as read only.
|
|
@@ -3541,6 +4005,7 @@
|
|
|
3541
4005
|
<summary>
|
|
3542
4006
|
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitIdOptions"/> class.
|
|
3543
4007
|
</summary>
|
|
4008
|
+
<param name="copyFrom">The instance to copy from.</param>
|
|
3544
4009
|
</member>
|
|
3545
4010
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitIdOptions.When">
|
|
3546
4011
|
<summary>
|
|
@@ -3567,6 +4032,11 @@
|
|
|
3567
4032
|
Gets a value indicating whether this instance rejects all attempts to mutate it.
|
|
3568
4033
|
</summary>
|
|
3569
4034
|
</member>
|
|
4035
|
+
<member name="P:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitIdOptions.IsDefault">
|
|
4036
|
+
<summary>
|
|
4037
|
+
Gets a value indicating whether this instance is equivalent to the default instance.
|
|
4038
|
+
</summary>
|
|
4039
|
+
</member>
|
|
3570
4040
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitIdOptions.Freeze">
|
|
3571
4041
|
<summary>
|
|
3572
4042
|
Freezes this instance so no more changes can be made to it.
|
|
@@ -3581,11 +4051,6 @@
|
|
|
3581
4051
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitIdOptions.GetHashCode">
|
|
3582
4052
|
<inheritdoc />
|
|
3583
4053
|
</member>
|
|
3584
|
-
<member name="P:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitIdOptions.IsDefault">
|
|
3585
|
-
<summary>
|
|
3586
|
-
Gets a value indicating whether this instance is equivalent to the default instance.
|
|
3587
|
-
</summary>
|
|
3588
|
-
</member>
|
|
3589
4054
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitIdOptions.SetIfNotReadOnly``1(``0@,``0)">
|
|
3590
4055
|
<summary>
|
|
3591
4056
|
Sets the value of a field if this instance is not marked as read only.
|
|
@@ -3600,75 +4065,9 @@
|
|
|
3600
4065
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitIdOptions.EqualWithDefaultsComparer.GetHashCode(Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitIdOptions)">
|
|
3601
4066
|
<inheritdoc />
|
|
3602
4067
|
</member>
|
|
3603
|
-
<member name="M:Nerdbank.GitVersioning.VersionOptions.EqualWithDefaultsComparer.Equals(Nerdbank.GitVersioning.VersionOptions,Nerdbank.GitVersioning.VersionOptions)">
|
|
3604
|
-
<inheritdoc />
|
|
3605
|
-
</member>
|
|
3606
|
-
<member name="M:Nerdbank.GitVersioning.VersionOptions.EqualWithDefaultsComparer.GetHashCode(Nerdbank.GitVersioning.VersionOptions)">
|
|
3607
|
-
<inheritdoc />
|
|
3608
|
-
</member>
|
|
3609
|
-
<member name="T:Nerdbank.GitVersioning.VersionOptions.VersionPrecision">
|
|
3610
|
-
<summary>
|
|
3611
|
-
The last component to control in a 4 integer version.
|
|
3612
|
-
</summary>
|
|
3613
|
-
</member>
|
|
3614
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.VersionPrecision.Major">
|
|
3615
|
-
<summary>
|
|
3616
|
-
The first integer is the last number set. The rest will be zeros.
|
|
3617
|
-
</summary>
|
|
3618
|
-
</member>
|
|
3619
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.VersionPrecision.Minor">
|
|
3620
|
-
<summary>
|
|
3621
|
-
The second integer is the last number set. The rest will be zeros.
|
|
3622
|
-
</summary>
|
|
3623
|
-
</member>
|
|
3624
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.VersionPrecision.Build">
|
|
3625
|
-
<summary>
|
|
3626
|
-
The third integer is the last number set. The fourth will be zero.
|
|
3627
|
-
</summary>
|
|
3628
|
-
</member>
|
|
3629
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.VersionPrecision.Revision">
|
|
3630
|
-
<summary>
|
|
3631
|
-
All four integers will be set.
|
|
3632
|
-
</summary>
|
|
3633
|
-
</member>
|
|
3634
|
-
<member name="T:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitWhen">
|
|
3635
|
-
<summary>
|
|
3636
|
-
The conditions a commit ID is included in a cloud build number.
|
|
3637
|
-
</summary>
|
|
3638
|
-
</member>
|
|
3639
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitWhen.Always">
|
|
3640
|
-
<summary>
|
|
3641
|
-
Always include the commit information in the cloud Build Number.
|
|
3642
|
-
</summary>
|
|
3643
|
-
</member>
|
|
3644
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitWhen.NonPublicReleaseOnly">
|
|
3645
|
-
<summary>
|
|
3646
|
-
Only include the commit information when building a non-PublicRelease.
|
|
3647
|
-
</summary>
|
|
3648
|
-
</member>
|
|
3649
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitWhen.Never">
|
|
3650
|
-
<summary>
|
|
3651
|
-
Never include the commit information.
|
|
3652
|
-
</summary>
|
|
3653
|
-
</member>
|
|
3654
|
-
<member name="T:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitWhere">
|
|
3655
|
-
<summary>
|
|
3656
|
-
The position a commit ID can appear in a cloud build number.
|
|
3657
|
-
</summary>
|
|
3658
|
-
</member>
|
|
3659
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitWhere.BuildMetadata">
|
|
3660
|
-
<summary>
|
|
3661
|
-
The commit ID appears in build metadata (e.g. +ga1b2c3).
|
|
3662
|
-
</summary>
|
|
3663
|
-
</member>
|
|
3664
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitWhere.FourthVersionComponent">
|
|
3665
|
-
<summary>
|
|
3666
|
-
The commit ID appears as the 4th integer in the version (e.g. 1.2.3.23523).
|
|
3667
|
-
</summary>
|
|
3668
|
-
</member>
|
|
3669
4068
|
<member name="T:Nerdbank.GitVersioning.VersionOptions.ReleaseOptions">
|
|
3670
4069
|
<summary>
|
|
3671
|
-
Encapsulates settings for the "prepare-release" command
|
|
4070
|
+
Encapsulates settings for the "prepare-release" command.
|
|
3672
4071
|
</summary>
|
|
3673
4072
|
</member>
|
|
3674
4073
|
<member name="F:Nerdbank.GitVersioning.VersionOptions.ReleaseOptions.DefaultInstance">
|
|
@@ -3678,32 +4077,33 @@
|
|
|
3678
4077
|
</member>
|
|
3679
4078
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.ReleaseOptions.#ctor">
|
|
3680
4079
|
<summary>
|
|
3681
|
-
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.VersionOptions.ReleaseOptions"/> class
|
|
4080
|
+
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.VersionOptions.ReleaseOptions"/> class.
|
|
3682
4081
|
</summary>
|
|
3683
4082
|
</member>
|
|
3684
4083
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.ReleaseOptions.#ctor(Nerdbank.GitVersioning.VersionOptions.ReleaseOptions)">
|
|
3685
4084
|
<summary>
|
|
3686
|
-
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.VersionOptions.ReleaseOptions"/> class
|
|
4085
|
+
Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.VersionOptions.ReleaseOptions"/> class.
|
|
3687
4086
|
</summary>
|
|
4087
|
+
<param name="copyFrom">The existing instance to copy from.</param>
|
|
3688
4088
|
</member>
|
|
3689
4089
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.ReleaseOptions.BranchName">
|
|
3690
4090
|
<summary>
|
|
3691
|
-
Gets or sets the branch name template for release branches
|
|
4091
|
+
Gets or sets the branch name template for release branches.
|
|
3692
4092
|
</summary>
|
|
3693
4093
|
</member>
|
|
3694
4094
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.ReleaseOptions.BranchNameOrDefault">
|
|
3695
4095
|
<summary>
|
|
3696
|
-
Gets the set branch name template for release branches
|
|
4096
|
+
Gets the set branch name template for release branches.
|
|
3697
4097
|
</summary>
|
|
3698
4098
|
</member>
|
|
3699
4099
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.ReleaseOptions.VersionIncrement">
|
|
3700
4100
|
<summary>
|
|
3701
|
-
Gets or sets the setting specifying how to increment the version when creating a release
|
|
4101
|
+
Gets or sets the setting specifying how to increment the version when creating a release.
|
|
3702
4102
|
</summary>
|
|
3703
4103
|
</member>
|
|
3704
4104
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.ReleaseOptions.VersionIncrementOrDefault">
|
|
3705
4105
|
<summary>
|
|
3706
|
-
Gets
|
|
4106
|
+
Gets the setting specifying how to increment the version when creating a release.
|
|
3707
4107
|
</summary>
|
|
3708
4108
|
</member>
|
|
3709
4109
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.ReleaseOptions.FirstUnstableTag">
|
|
@@ -3713,7 +4113,7 @@
|
|
|
3713
4113
|
</member>
|
|
3714
4114
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.ReleaseOptions.FirstUnstableTagOrDefault">
|
|
3715
4115
|
<summary>
|
|
3716
|
-
Gets
|
|
4116
|
+
Gets the first/default prerelease tag for new versions.
|
|
3717
4117
|
</summary>
|
|
3718
4118
|
</member>
|
|
3719
4119
|
<member name="P:Nerdbank.GitVersioning.VersionOptions.ReleaseOptions.IsFrozen">
|
|
@@ -3721,6 +4121,11 @@
|
|
|
3721
4121
|
Gets a value indicating whether this instance rejects all attempts to mutate it.
|
|
3722
4122
|
</summary>
|
|
3723
4123
|
</member>
|
|
4124
|
+
<member name="P:Nerdbank.GitVersioning.VersionOptions.ReleaseOptions.IsDefault">
|
|
4125
|
+
<summary>
|
|
4126
|
+
Gets a value indicating whether this instance is equivalent to the default instance.
|
|
4127
|
+
</summary>
|
|
4128
|
+
</member>
|
|
3724
4129
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.ReleaseOptions.Freeze">
|
|
3725
4130
|
<summary>
|
|
3726
4131
|
Freezes this instance so no more changes can be made to it.
|
|
@@ -3735,11 +4140,6 @@
|
|
|
3735
4140
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.ReleaseOptions.GetHashCode">
|
|
3736
4141
|
<inheritdoc />
|
|
3737
4142
|
</member>
|
|
3738
|
-
<member name="P:Nerdbank.GitVersioning.VersionOptions.ReleaseOptions.IsDefault">
|
|
3739
|
-
<summary>
|
|
3740
|
-
Gets a value indicating whether this instance is equivalent to the default instance.
|
|
3741
|
-
</summary>
|
|
3742
|
-
</member>
|
|
3743
4143
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.ReleaseOptions.SetIfNotReadOnly``1(``0@,``0)">
|
|
3744
4144
|
<summary>
|
|
3745
4145
|
Sets the value of a field if this instance is not marked as read only.
|
|
@@ -3754,25 +4154,11 @@
|
|
|
3754
4154
|
<member name="M:Nerdbank.GitVersioning.VersionOptions.ReleaseOptions.EqualWithDefaultsComparer.GetHashCode(Nerdbank.GitVersioning.VersionOptions.ReleaseOptions)">
|
|
3755
4155
|
<inheritdoc />
|
|
3756
4156
|
</member>
|
|
3757
|
-
<member name="
|
|
3758
|
-
<
|
|
3759
|
-
Possible increments of the version after creating release branches
|
|
3760
|
-
</summary>
|
|
3761
|
-
</member>
|
|
3762
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.ReleaseVersionIncrement.Major">
|
|
3763
|
-
<summary>
|
|
3764
|
-
Increment the major version after creating a release branch
|
|
3765
|
-
</summary>
|
|
3766
|
-
</member>
|
|
3767
|
-
<member name="F:Nerdbank.GitVersioning.VersionOptions.ReleaseVersionIncrement.Minor">
|
|
3768
|
-
<summary>
|
|
3769
|
-
Increment the minor version after creating a release branch
|
|
3770
|
-
</summary>
|
|
4157
|
+
<member name="M:Nerdbank.GitVersioning.VersionOptions.EqualWithDefaultsComparer.Equals(Nerdbank.GitVersioning.VersionOptions,Nerdbank.GitVersioning.VersionOptions)">
|
|
4158
|
+
<inheritdoc />
|
|
3771
4159
|
</member>
|
|
3772
|
-
<member name="
|
|
3773
|
-
<
|
|
3774
|
-
Increment the build number (the third number in a version) after creating a release branch.
|
|
3775
|
-
</summary>
|
|
4160
|
+
<member name="M:Nerdbank.GitVersioning.VersionOptions.EqualWithDefaultsComparer.GetHashCode(Nerdbank.GitVersioning.VersionOptions)">
|
|
4161
|
+
<inheritdoc />
|
|
3776
4162
|
</member>
|
|
3777
4163
|
<member name="M:Nerdbank.GitVersioning.VersionOptionsContractResolver.ResolveContract(System.Type)">
|
|
3778
4164
|
<summary>
|
|
@@ -3786,6 +4172,9 @@
|
|
|
3786
4172
|
So instead, we cache with a complex key to capture the settings as well.
|
|
3787
4173
|
</remarks>
|
|
3788
4174
|
</member>
|
|
4175
|
+
<member name="M:Nerdbank.GitVersioning.VersionOptionsContractResolver.CreateProperty(System.Reflection.MemberInfo,Newtonsoft.Json.MemberSerialization)">
|
|
4176
|
+
<inheritdoc/>
|
|
4177
|
+
</member>
|
|
3789
4178
|
<member name="T:Nerdbank.GitVersioning.VersionOracle">
|
|
3790
4179
|
<summary>
|
|
3791
4180
|
Assembles version information in a variety of formats.
|
|
@@ -3809,16 +4198,6 @@
|
|
|
3809
4198
|
<param name="cloudBuild">An optional cloud build provider that may offer additional context. Typically set to <see cref="P:Nerdbank.GitVersioning.CloudBuild.Active"/>.</param>
|
|
3810
4199
|
<param name="overrideVersionHeightOffset">An optional value to override the version height offset.</param>
|
|
3811
4200
|
</member>
|
|
3812
|
-
<member name="P:Nerdbank.GitVersioning.VersionOracle.CommittedVersion">
|
|
3813
|
-
<summary>
|
|
3814
|
-
Gets the <see cref="P:Nerdbank.GitVersioning.VersionOracle.VersionOptions"/> that were deserialized from the contextual commit, if any.
|
|
3815
|
-
</summary>
|
|
3816
|
-
</member>
|
|
3817
|
-
<member name="P:Nerdbank.GitVersioning.VersionOracle.WorkingVersion">
|
|
3818
|
-
<summary>
|
|
3819
|
-
Gets the <see cref="P:Nerdbank.GitVersioning.VersionOracle.VersionOptions"/> that were deserialized from the working tree, if any.
|
|
3820
|
-
</summary>
|
|
3821
|
-
</member>
|
|
3822
4201
|
<member name="P:Nerdbank.GitVersioning.VersionOracle.CloudBuildNumber">
|
|
3823
4202
|
<summary>
|
|
3824
4203
|
Gets the BuildNumber to set the cloud build to (if applicable).
|
|
@@ -3925,26 +4304,26 @@
|
|
|
3925
4304
|
</member>
|
|
3926
4305
|
<member name="P:Nerdbank.GitVersioning.VersionOracle.VersionHeight">
|
|
3927
4306
|
<summary>
|
|
3928
|
-
Gets the number of commits in the longest single path between
|
|
4307
|
+
Gets or sets the number of commits in the longest single path between
|
|
3929
4308
|
the specified commit and the most distant ancestor (inclusive)
|
|
3930
4309
|
that set the version to the value at HEAD.
|
|
3931
4310
|
</summary>
|
|
3932
4311
|
</member>
|
|
3933
4312
|
<member name="P:Nerdbank.GitVersioning.VersionOracle.VersionHeightOffset">
|
|
3934
4313
|
<summary>
|
|
3935
|
-
|
|
4314
|
+
Gets the offset to add to the <see cref="P:Nerdbank.GitVersioning.VersionOracle.VersionHeight"/>
|
|
3936
4315
|
when calculating the integer to use as the <see cref="P:Nerdbank.GitVersioning.VersionOracle.BuildNumber"/>
|
|
3937
4316
|
or elsewhere that the {height} macro is used.
|
|
3938
4317
|
</summary>
|
|
3939
4318
|
</member>
|
|
3940
4319
|
<member name="P:Nerdbank.GitVersioning.VersionOracle.BuildingRef">
|
|
3941
4320
|
<summary>
|
|
3942
|
-
Gets the ref (branch or tag) being built.
|
|
4321
|
+
Gets or sets the ref (branch or tag) being built.
|
|
3943
4322
|
</summary>
|
|
3944
4323
|
</member>
|
|
3945
4324
|
<member name="P:Nerdbank.GitVersioning.VersionOracle.Version">
|
|
3946
4325
|
<summary>
|
|
3947
|
-
Gets the version for this project, with up to 4 components.
|
|
4326
|
+
Gets or sets the version for this project, with up to 4 components.
|
|
3948
4327
|
</summary>
|
|
3949
4328
|
</member>
|
|
3950
4329
|
<member name="P:Nerdbank.GitVersioning.VersionOracle.CloudBuildAllVarsEnabled">
|
|
@@ -4000,13 +4379,13 @@
|
|
|
4000
4379
|
<member name="P:Nerdbank.GitVersioning.VersionOracle.SemVer1">
|
|
4001
4380
|
<summary>
|
|
4002
4381
|
Gets a SemVer 1.0 compliant string that represents this version, including the -COMMITID suffix
|
|
4003
|
-
when <see cref="P:Nerdbank.GitVersioning.VersionOracle.PublicRelease"/> is <
|
|
4382
|
+
when <see cref="P:Nerdbank.GitVersioning.VersionOracle.PublicRelease"/> is <see langword="false"/>.
|
|
4004
4383
|
</summary>
|
|
4005
4384
|
</member>
|
|
4006
4385
|
<member name="P:Nerdbank.GitVersioning.VersionOracle.SemVer2">
|
|
4007
4386
|
<summary>
|
|
4008
4387
|
Gets a SemVer 2.0 compliant string that represents this version, including a +COMMITID suffix
|
|
4009
|
-
when <see cref="P:Nerdbank.GitVersioning.VersionOracle.PublicRelease"/> is <
|
|
4388
|
+
when <see cref="P:Nerdbank.GitVersioning.VersionOracle.PublicRelease"/> is <see langword="false"/>.
|
|
4010
4389
|
</summary>
|
|
4011
4390
|
</member>
|
|
4012
4391
|
<member name="P:Nerdbank.GitVersioning.VersionOracle.SemVer1NumericIdentifierPadding">
|
|
@@ -4019,6 +4398,16 @@
|
|
|
4019
4398
|
Gets or sets the <see cref="P:Nerdbank.GitVersioning.VersionOracle.CloudBuildNumberOptions"/>.
|
|
4020
4399
|
</summary>
|
|
4021
4400
|
</member>
|
|
4401
|
+
<member name="P:Nerdbank.GitVersioning.VersionOracle.CommittedVersion">
|
|
4402
|
+
<summary>
|
|
4403
|
+
Gets the <see cref="P:Nerdbank.GitVersioning.VersionOracle.VersionOptions"/> that were deserialized from the contextual commit, if any.
|
|
4404
|
+
</summary>
|
|
4405
|
+
</member>
|
|
4406
|
+
<member name="P:Nerdbank.GitVersioning.VersionOracle.WorkingVersion">
|
|
4407
|
+
<summary>
|
|
4408
|
+
Gets the <see cref="P:Nerdbank.GitVersioning.VersionOracle.VersionOptions"/> that were deserialized from the working tree, if any.
|
|
4409
|
+
</summary>
|
|
4410
|
+
</member>
|
|
4022
4411
|
<member name="P:Nerdbank.GitVersioning.VersionOracle.NuGetSemVer1BuildMetadata">
|
|
4023
4412
|
<summary>
|
|
4024
4413
|
Gets the build metadata, compliant to the NuGet-compatible subset of SemVer 1.0.
|
|
@@ -4038,13 +4427,13 @@
|
|
|
4038
4427
|
<member name="P:Nerdbank.GitVersioning.VersionOracle.NuGetSemVer1">
|
|
4039
4428
|
<summary>
|
|
4040
4429
|
Gets a SemVer 1.0 compliant string that represents this version, including the -gCOMMITID suffix
|
|
4041
|
-
when <see cref="P:Nerdbank.GitVersioning.VersionOracle.PublicRelease"/> is <
|
|
4430
|
+
when <see cref="P:Nerdbank.GitVersioning.VersionOracle.PublicRelease"/> is <see langword="false"/>.
|
|
4042
4431
|
</summary>
|
|
4043
4432
|
</member>
|
|
4044
4433
|
<member name="P:Nerdbank.GitVersioning.VersionOracle.NuGetSemVer2">
|
|
4045
4434
|
<summary>
|
|
4046
4435
|
Gets a SemVer 2.0 compliant string that represents this version, including the -gCOMMITID suffix
|
|
4047
|
-
when <see cref="P:Nerdbank.GitVersioning.VersionOracle.PublicRelease"/> is <
|
|
4436
|
+
when <see cref="P:Nerdbank.GitVersioning.VersionOracle.PublicRelease"/> is <see langword="false"/>.
|
|
4048
4437
|
</summary>
|
|
4049
4438
|
</member>
|
|
4050
4439
|
<member name="P:Nerdbank.GitVersioning.VersionOracle.SemVer2BuildMetadata">
|
|
@@ -4054,8 +4443,8 @@
|
|
|
4054
4443
|
<remarks>
|
|
4055
4444
|
We always put the commit ID in the -prerelease tag for non-public releases.
|
|
4056
4445
|
But for public releases, we don't include it in the +buildMetadata section since it may be confusing for NuGet.
|
|
4057
|
-
See https://github.com/dotnet/Nerdbank.GitVersioning/pull/132#issuecomment-307208561
|
|
4058
4446
|
</remarks>
|
|
4447
|
+
<seealso href="https://github.com/dotnet/Nerdbank.GitVersioning/pull/132#issuecomment-307208561"/>
|
|
4059
4448
|
</member>
|
|
4060
4449
|
<member name="P:Nerdbank.GitVersioning.VersionOracle.GitCommitIdShortForNonPublicPrereleaseTag">
|
|
4061
4450
|
<summary>
|
|
@@ -4076,7 +4465,7 @@
|
|
|
4076
4465
|
</member>
|
|
4077
4466
|
<member name="T:Nerdbank.GitVersioning.SemanticVersionExtensions">
|
|
4078
4467
|
<summary>
|
|
4079
|
-
Extension methods for <see cref="T:Nerdbank.GitVersioning.SemanticVersion"
|
|
4468
|
+
Extension methods for <see cref="T:Nerdbank.GitVersioning.SemanticVersion"/>.
|
|
4080
4469
|
</summary>
|
|
4081
4470
|
</member>
|
|
4082
4471
|
<member name="F:Nerdbank.GitVersioning.SemanticVersionExtensions.NumericIdentifierRegex">
|
|
@@ -4098,7 +4487,7 @@
|
|
|
4098
4487
|
</summary>
|
|
4099
4488
|
<param name="version">The version which's prerelease tag to modify.</param>
|
|
4100
4489
|
<param name="newFirstTag">The new prerelease tag. The leading hyphen may be specified or omitted.</param>
|
|
4101
|
-
<returns>Returns a new instance of <see cref="T:Nerdbank.GitVersioning.SemanticVersion"/> with the updated prerelease tag
|
|
4490
|
+
<returns>Returns a new instance of <see cref="T:Nerdbank.GitVersioning.SemanticVersion"/> with the updated prerelease tag.</returns>
|
|
4102
4491
|
</member>
|
|
4103
4492
|
<member name="M:Nerdbank.GitVersioning.SemanticVersionExtensions.WithoutPrepreleaseTags(Nerdbank.GitVersioning.SemanticVersion)">
|
|
4104
4493
|
<summary>
|