kotlin-dsl/DotnetNugetDelete.xml

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


<dsl-extension kind="buildStep" type="dotnet" generateDslJar="true" applicable="params['command'] == 'nuget-delete'">
    <class name="DotnetNugetDeleteStep">
        <description>
            A [dotnet nuget delete step](https://github.com/JetBrains/teamcity-dotnet-plugin) to run .NET CLI command
        </description>
    </class>
    <function name="dotnetNugetDelete">
        <description>
            Adds a [dotnet nuget delete step](https://github.com/JetBrains/teamcity-dotnet-plugin) to run .NET CLI command
            @see DotnetNugetDeleteStep
        </description>
    </function>
    <init>
        <param name="command" value="nuget-delete"/>
    </init>
    <params>
        <param name="nuget.packageSource" dslName="serverUrl" mandatory="true">
            <description>Specify the server URL.</description>
        </param>
        <param name="nuget.packageId" dslName="packageId" mandatory="true">
            <description>Specify the package name and version separated by a space.</description>
        </param>
        <param name="secure:nuget.apiKey" dslName="apiKey" mandatory="true">
            <description>Specify the API key to access the NuGet packages feed.</description>
        </param>
        <param name="args">
            <description>Enter additional command line parameters for dotnet nuget delete.</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 nuget delete`](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-nuget-delete) command to delete a specified package from a specified server
            </description>
            <code>
                dotnetNugetDelete {
                    serverUrl = "https://nuget.example.com/feed"
                    packageId = "MyPackage 1.2.3"
                    apiKey = "******"
                }
            </code>
        </example>
    </examples>
</dsl-extension>