Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Cake.WebDeploy

Cake-Build addin that extends Cake with WebDeploy commands for publishing to IIS

Build status

cakebuild.net

Join the chat at https://gitter.im/cake-build/cake

Table of contents

  1. Implemented functionality
  2. Referencing
  3. Usage
  4. Example
  5. TroubleShooting
  6. Plays well with
  7. License
  8. Share the love

Implemented functionality

  • Deploy websites from a package or folder
  • Locally / remotely using credentials
  • Outputting the trace information to the cake log
  • Testing changes using WhatIf flag

Referencing

NuGet Version NuGet Downloads

Cake.WebDeploy is available as a nuget package from the package manager console:

Install-Package Cake.WebDeploy

or directly in your build script via a cake addin directive:

#addin "Cake.WebDeploy"

Usage

#addin "Cake.WebDeploy"

Task("Deploy")
    .Description("Deploy to a remote computer with web deployment agent installed")
    .Does(() =>
    {
        DeployWebsite(new DeploySettings()
        {
            SourcePath = "./src/Package.zip",
            SiteName = "TestSite",

            ComputerName = "remote-location",
            Username = "admin",
            Password = "pass1"
        });
    });


Task("Deploy-Folder")
    .Description("Deploy to/from folders")
    .Does(() =>
    {
        DeployWebsite(new DeploySettings()
        {
            SourcePath = "./src/Website/",
            DestinationPath = @"C:/src/Websites/Test/",

            Username = "admin",
            Password = "pass1"
        });
    });


Task("Deploy-Url")
    .Description("Deploy to Azure using a custom Url")
    .Does(() =>
    {
        DeployWebsite(new DeploySettings()
        {
            SourcePath = "./src/Package.zip",
            PublishUrl = "{WEBSITENAME}.scm.azurewebsites.net",

            Username = "admin",
            Password = "pass1"
        });
    });


Task("Deploy-Fluent")
    .Description("Deploy using fluent settings")
    .Does(() =>
    {
        DeployWebsite(new DeploySettings()
            .FromSourcePath("./src/Package.zip")
            .UseSiteName("TestSite")
            .UseComputerName("remote-location")
            .UseUsername("admin")
            .UsePassword("pass1"));
    });


Task("Deploy-WhatIf")
    .Description("See what would occur when publishing (WhatIf) and files should be deleted if they don't exist (Delete)")
    .Does(() =>
    {
        DeployWebsite(new DeploySettings()
        {
            SourcePath = "./src/Package.zip",

            Username = "admin",
            Password = "pass1",

            Delete = true,
            WhatIf = true
        });
    });

RunTarget("Deploy");

Example

A complete Cake example can be found here.

TroubleShooting

  • Please be aware of the breaking changes that occurred with the release of Cake v0.22.0, as a result you will need to upgrade Cake in order to use Cake.WebDeploy [v0.3.0] or above.
  • Please appreciate that this project is a wrapper for MS WebDeploy, so before raising an issue please ensure you can perform the task using MS WebDeploy directly. Microsoft has loads of great articles on WebDeploy on the IIS website.

A few pointers for correctly enabling WebDeploy scripting can be found here.

Plays well with

If your looking to manage IIS its worth checking out Cake.IIS or if your running a WebFarm inside AWS then check out Cake.AWS.ElasticLoadBalancing.

If your looking for a way to trigger cake tasks based on windows events or at scheduled intervals then check out CakeBoss.

License

Copyright (c) 2015 - 2016 Phillip Sharpe

Cake.WebDeploy is provided as-is under the MIT license. For more information see LICENSE.

Share the love

If this project helps you in anyway then please the repository.

About

WebDeploy addin for Cake

Resources

License

Releases

No releases published

Packages

No packages published