ScriptDeployTools 2.0.5

.NET 9.0 This package targets .NET 9.0. The package is compatible with this framework or higher. 
dotnet add package ScriptDeployTools --version 2.0.5
                    


                    

                
NuGet\Install-Package ScriptDeployTools -Version 2.0.5
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="ScriptDeployTools" Version="2.0.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="ScriptDeployTools" Version="2.0.5" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="ScriptDeployTools" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add ScriptDeployTools --version 2.0.5
                    


                    

                
#r "nuget: ScriptDeployTools, 2.0.5"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package ScriptDeployTools@2.0.5
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=ScriptDeployTools&version=2.0.5
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=ScriptDeployTools&version=2.0.5
                    


                            Install as a Cake Tool

ScriptDeployTools

Inspired by DbUp supporting easy filtering, ordering and versioning:

GitHub Actions Workflow Status

Key

Not deployed if a script with the same key is already deployed.

DependsOn

Not deployed unless a script with this key is deployed.

ActualBefore

Not deployed if a script with this key is already deployed.

CanRepeat and ContentsHash

It is deployed every time if the hash has changed.

Used extensions are implemented IDeploySource and IDeployTarget for different sources and targets.

OrderGroup

Deploying by groups in special sequences

IsService

This script not sorting and deployed only in special code (e.g. insert migrations)

IsInitializeTarget

This scripts can deploy when target is not created (e.g. script to create database).

Define script

Used class (implementation of IScript) for describe script's properties:

internal record DeviceTypes() : ScriptBase("DEVICE_TYPES")
{
    public override string DependsOn => "IDENTITY_COMMON";

    public override string Source => "SqlServerDeploy.Scripts.v1_0_0.Tables.DeviceTypes.sql";
}

Script's content stored in resources by path from properties "Source" (implemented for package ScriptDeployTools.Sources.Embedded).

Used

var deployService = new DeployBuilder()
    .AddLogger(loggerFactory.CreateLogger<IDeploymentService>())
    .AddOptions(new DeploymentOptions
    {
        InsertMigrationScript = scripts.FirstOrDefault(x =>
            x is { IsService: true, ScriptKey: "INSERT_MIGRATION" })
    })
    .FromEmbeddedResources(options =>
    {
        options.Assemblies = [typeof(DeployHelper).Assembly];
    })
    .ToSqlServer(options =>
    {
        options.ConnectionString = connectionString;
        options.GetDeployedInfoScript = scripts.FirstOrDefault(x =>
            x is { IsService: true, ScriptKey: "GET_DEPLOYED_SCRIPTS" });
    })
    .Build();

await deployService.Deploy(scripts, cancellationToken);

A more detailed example is available in this repository.

Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on ScriptDeployTools:

Package Downloads
ScriptDeployTools.Targets.SqlServer

Deploy scripts to SQL Server
ScriptDeployTools.Sources.Embedded

Deploy scripts from sources

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.0.5 294 3/23/2025