kotlin-dsl/DotnetRestore.xml

<?xml version="1.0" encoding="UTF-8"?>


<dsl-extension kind="buildStep" type="dotnet" generateDslJar="true" applicable="params['command'] == 'restore'">
    <class name="DotnetRestoreStep">
        <description>
            A [dotnet restore step](https://github.com/JetBrains/teamcity-dotnet-plugin) to run .NET CLI command
        </description>
    </class>
    <function name="dotnetRestore">
        <description>
            Adds a [dotnet restore step](https://github.com/JetBrains/teamcity-dotnet-plugin) to run .NET CLI command
            @see DotnetRestoreStep
        </description>
    </function>
    <init>
        <param name="command" value="restore"/>
    </init>
    <params>
        <param name="paths" dslName="projects">
            <description>Specify paths to projects and solutions. Wildcards are supported.</description>
        </param>
        <param name="teamcity.build.workingDir" dslName="workingDir" yamlName="working-directory">
            <description>
                [Build working directory](https://www.jetbrains.com/help/teamcity/?Build+Working+Directory) for
                script,
                specify it if it is different from the [checkout
                directory](https://www.jetbrains.com/help/teamcity/?Build+Checkout+Directory).
            </description>
        </param>
        <param name="nuget.packageSources" dslName="sources">
            <description>Specifies NuGet package sources to use during the restore.</description>
        </param>
        <param name="runtime">
            <description>Target runtime to restore packages.</description>
        </param>
        <param name="nuget.packagesDir" dslName="packagesDir">
            <description>The directory to restore packages.</description>
        </param>
        <param name="nuget.configFile" dslName="configFile">
            <description>The NuGet configuration file to use.</description>
        </param>
        <param name="args">
            <description>Enter additional command line parameters for dotnet restore.</description>
        </param>
        <param name="verbosity" dslName="logging" type="Verbosity">
            <description>
                Specify logging verbosity
                @see Verbosity
            </description>
        </param>
        <param name="required.sdk" dslName="sdk">
            <description>.NET SDK versions separated by semicolon to be required on agents.</description>
        </param>
    </params>
    <types>
        <enum name="Verbosity">
            <description>
                Logging verbosity
            </description>
            <option name="Quiet" value="Quiet"/>
            <option name="Minimal" value="Minimal"/>
            <option name="Normal" value="Normal"/>
            <option name="Detailed" value="Detailed"/>
            <option name="Diagnostic" value="Diagnostic"/>
        </enum>
    </types>
    <examples>
        <example>
            <description>
                Runs [`dotnet restore`](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-restore) command for the MyProject.sln solution file.
            </description>
            <code>
                dotnetRestore {
                    projects = "MyProject.sln"
                }
            </code>
        </example>
    </examples>
</dsl-extension>