nerdbank-gitversioning 3.9.50 → 3.10.70

package/nbgv.cli/tools/net10.0/any/nbgv.runtimeconfig.json

@@ -0,0 +1,14 @@
+{
+  "runtimeOptions": {
+    "tfm": "net10.0",
+    "framework": {
+      "name": "Microsoft.NETCore.App",
+      "version": "10.0.0"
+    },
+    "rollForwardOnNoCandidateFx": 2,
+    "configProperties": {
+      "System.Reflection.Metadata.MetadataUpdater.IsSupported": false,
+      "System.Runtime.Serialization.EnableUnsafeBinaryFormatterSerialization": false
+    }
+  }
+}

package/nbgv.cli/tools/net10.0/any/nbgv.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0"?>
+<doc>
+    <assembly>
+        <name>nbgv</name>
+    </assembly>
+    <members>
+        <member name="M:Nerdbank.GitVersioning.Tool.Program.GetEffectiveGitEngine(System.Boolean)">
+            <summary>
+            Gets the effective git engine to use based on environment variables and command settings.
+            </summary>
+            <param name="preferReadWrite">Whether to prefer ReadWrite (LibGit2) engine when not explicitly specified.</param>
+            <returns>The engine to use.</returns>
+        </member>
+        <member name="M:Nerdbank.GitVersioning.GitLoaderContext.#ctor(System.String)">
+            <summary>
+            Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.GitLoaderContext"/> class.
+            </summary>
+            <param name="nativeDependencyBasePath">The path to the directory that contains the "runtimes" folder.</param>
+        </member>
+        <member name="M:Nerdbank.GitVersioning.GitLoaderContext.Load(System.Reflection.AssemblyName)">
+            <inheritdoc/>
+        </member>
+    </members>
+</doc>

package/nbgv.cli/tools/net8.0/any/Nerdbank.GitVersioning.xml

@@ -2992,7 +2992,7 @@
             Output information about the release as JSON.
             </summary>
         </member>
-        <member name="M:Nerdbank.GitVersioning.ReleaseManager.PrepareRelease(System.String,System.String,System.Version,System.Nullable{Nerdbank.GitVersioning.VersionOptions.ReleaseVersionIncrement},Nerdbank.GitVersioning.ReleaseManager.ReleaseManagerOutputMode,System.String)">
+        <member name="M:Nerdbank.GitVersioning.ReleaseManager.PrepareRelease(System.String,System.String,System.Version,System.Nullable{Nerdbank.GitVersioning.VersionOptions.ReleaseVersionIncrement},Nerdbank.GitVersioning.ReleaseManager.ReleaseManagerOutputMode,System.String,System.Boolean)">
             <summary>
             Prepares a release for the specified directory by creating a release branch and incrementing the version in the current branch.
             </summary>
@@ -3020,6 +3020,48 @@
             <param name="unformattedCommitMessage">
             An optional, custom message to use for the commit that sets the new version number. May use <c>{0}</c> to substitute the new version number.
             </param>
+            <param name="whatIf">
+            If true, simulates the prepare-release operation and returns the versions that would be set without making any changes.
+            </param>
+            <returns>
+            A <see cref="T:Nerdbank.GitVersioning.ReleaseManager.ReleaseInfo"/> object containing information about the release when <paramref name="whatIf"/> is true; otherwise null.
+            </returns>
+        </member>
+        <member name="M:Nerdbank.GitVersioning.ReleaseManager.PrepareReleaseCore(System.String,System.String,System.Version,System.Nullable{Nerdbank.GitVersioning.VersionOptions.ReleaseVersionIncrement},Nerdbank.GitVersioning.ReleaseManager.ReleaseManagerOutputMode,System.String,System.Boolean)">
+            <summary>
+            Core implementation of prepare-release functionality that can either simulate or execute the operation.
+            </summary>
+            <param name="projectDirectory">
+            The path to the directory that may (or its ancestors may) define the version file.
+            </param>
+            <param name="releaseUnstableTag">
+            An optional prerelease tag to apply on the release branch.
+            If not specified, any existing prerelease tag will be removed from the release.
+            The preceding hyphen may be omitted.
+            </param>
+            <param name="nextVersion">
+            The version to use for the next release.
+            If not specified, the next version will be determined automatically by incrementing the current
+            version based on the current version and the <paramref name="versionIncrement"/> setting in <c>version.json</c>.
+            Parameter will be ignored if the current branch is a release branch.
+            </param>
+            <param name="versionIncrement">
+            The increment to apply in order to determine the next version on the current branch.
+            If specified, value will be used instead of the increment specified in <c>version.json</c>.
+            Parameter will be ignored if the current branch is a release branch.
+            </param>
+            <param name="outputMode">
+            The output format to use for writing to stdout.
+            </param>
+            <param name="unformattedCommitMessage">
+            An optional, custom message to use for the commit that sets the new version number. May use <c>{0}</c> to substitute the new version number.
+            </param>
+            <param name="whatIf">
+            If true, simulates the prepare-release operation and returns the versions that would be set without making any changes.
+            </param>
+            <returns>
+            A <see cref="T:Nerdbank.GitVersioning.ReleaseManager.ReleaseInfo"/> object containing information about the release when <paramref name="whatIf"/> is true; otherwise null.
+            </returns>
         </member>
         <member name="T:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationException">
             <summary>
@@ -3453,6 +3495,16 @@
             <param name="versionTextContent">The content of the version.txt file to read.</param>
             <returns>The version information read from the file; or <see langword="null"/> if a deserialization error occurs.</returns>
         </member>
+        <member name="M:Nerdbank.GitVersioning.VersionFile.ApplyPrereleaseProperty(Nerdbank.GitVersioning.VersionOptions)">
+            <summary>
+            Applies the standalone <see cref="P:Nerdbank.GitVersioning.VersionOptions.Prerelease"/> property to the <see cref="P:Nerdbank.GitVersioning.VersionOptions.Version"/> property.
+            </summary>
+            <param name="options">The version options to modify.</param>
+            <remarks>
+            This method should be called after merging a child version.json with a parent version.json.
+            If the child specified a <see cref="P:Nerdbank.GitVersioning.VersionOptions.Prerelease"/> property, this method will apply it to the version.
+            </remarks>
+        </member>
         <member name="M:Nerdbank.GitVersioning.VersionFile.GetVersionCore(Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)">
             <summary>
             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.
@@ -3603,6 +3655,11 @@
             Backing field for the <see cref="P:Nerdbank.GitVersioning.VersionOptions.Inherit"/> property.
             </summary>
         </member>
+        <member name="F:Nerdbank.GitVersioning.VersionOptions.prerelease">
+            <summary>
+            Backing field for the <see cref="P:Nerdbank.GitVersioning.VersionOptions.Prerelease"/> property.
+            </summary>
+        </member>
         <member name="M:Nerdbank.GitVersioning.VersionOptions.#ctor">
             <summary>
             Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.VersionOptions"/> class.
@@ -3871,6 +3928,22 @@
             When this is <see langword="true"/>, this object may not completely describe the options to be applied.
             </remarks>
         </member>
+        <member name="P:Nerdbank.GitVersioning.VersionOptions.Prerelease">
+            <summary>
+            Gets or sets a prerelease tag to append to an inherited version.
+            </summary>
+            <remarks>
+            <para>
+            This property is only valid when <see cref="P:Nerdbank.GitVersioning.VersionOptions.Inherit"/> is <see langword="true"/> and the <see cref="P:Nerdbank.GitVersioning.VersionOptions.Version"/> property
+            does not already include a prerelease tag. When set, this prerelease tag will be appended to the version number
+            inherited from the parent version.json file.
+            </para>
+            <para>
+            Setting this to an empty string explicitly suppresses any prerelease tag that might be inherited.
+            Omitting this property (leaving it as <see langword="null"/>) means the prerelease tag will be inherited as-is from the parent.
+            </para>
+            </remarks>
+        </member>
         <member name="P:Nerdbank.GitVersioning.VersionOptions.IsFrozen">
             <summary>
             Gets a value indicating whether this instance rejects all attempts to mutate it.