{"id":1874,"date":"2020-05-25T10:32:40","date_gmt":"2020-05-25T09:32:40","guid":{"rendered":"http:\/\/www.stuartroberts.net\/?p=1874"},"modified":"2020-07-17T11:51:51","modified_gmt":"2020-07-17T10:51:51","slug":"scripting-add-in-packages","status":"publish","type":"post","link":"http:\/\/www.stuartroberts.net\/index.php\/2020\/05\/25\/scripting-add-in-packages\/","title":{"rendered":"Scripting Add-Ins for Deployment"},"content":{"rendered":"\n

Scripting the creation of SharePoint add-in packages is pretty straight forward. As I found there to be not very many posts on this topic, I thought I’d share how I implemented it.<\/p>\n\n\n\n

To create and deploy is also easy from a developers box, all of this is achievable from inside Visual Studio.<\/p>\n\n\n\n

The purpose of this post is to show how you would go about creating packages to be deployed on downstream environments.<\/p>\n\n\n\n

I’m not going to go into the creation of certificates or the add-in client id. I’m going to take it for granted that if you’ve got to this stage, you already know how to do all of that.<\/p>\n\n\n\n

Lets say you have a solution with one add-in and related web and you want to be able to script the creation of the packages to your UA environment.<\/p>\n\n\n\n\n\n\n\n

Configure Add-In Profile<\/h2>\n\n\n\n

In Visual Studio, right click the add-in project and choose Publish. From the Publish your add-in page, choose New from the current profile drop down.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Populate the profile with the certificate details for the environment you’re wanting to package for and click Finish.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Configure Remote Web Profile<\/h2>\n\n\n\n

Next we need to configure the web part of the profile. Locate the web project for your add-in and right click it and once again then choose Publish.<\/p>\n\n\n\n

At the top of the page that loads, click New to launch the Pick a publish target<\/em> dialog. From there, select IIS, FTP, etc and then Create Profile.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

<\/p>\n\n\n\n

Change the Publish method<\/em> to Web Deploy Package, then set a package location and the target web application path.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Click Next and choose the configuration profile for this build. Finally click save to complete the profile for this add-in and web.<\/p>\n\n\n\n

In the Solution Explorer pane, expand the Properties\\PublishProfiles folder within the web project. Here you’ll see the profile that you created above.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

If you open this file, you’ll see all of the settings you entered for the add-in and web projects.<\/p>\n\n\n\n

Scripting Package Creation<\/h2>\n\n\n\n

We’ll be using msbuild to script the creation of the packages for the add-in<\/p>\n\n\n

\n#Change to thefolder that contains the add-in project file\ncd "C:\\location of the projects"\n\n# Build and create the packages for the add-in and web\n& "C:\\path to msbuild\\msbuild" \/t:addinproject.csproj \/p:IsPackaging=True \/p:DeployOnBuild=false \/property:Configuration=Release \/p:PublishDir=C:\\PublishFolder \/p:ActivePublishProfile=CustomProfile\n<\/pre><\/div>\n\n\n
\n
Property<\/th>Description<\/th><\/tr><\/thead>
IsPackaging<\/td>Set to True to create the packages after the build<\/td><\/tr>
DeployOnBuild<\/td>We don’t want to deploy anywhere during this process, so set this to False<\/td><\/tr>
Configuration<\/td>The solution configuration name<\/td><\/tr>
PublishDir<\/td>The location to publish the packages to.
If you set this to C:\\Packages\\AddIn msbuild will create a folder called C:\\Packages\\AddIn1.0.0.0
Basically it appends the version of the add-in the this path<\/td><\/tr>
ActivePublishProfile<\/td>The name of the publishing profile that you created previously<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/div><\/div>\n\n\n\n
Once packing has completed, go to the folder you provided for PublishDir above. Here you should see 6 files:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
If you open the SetParameters.xml file you’ll see all the settings for the profile you targeted in the packaging process. This will be used when deploying with the web.deploy.cmd batch file.<\/p>\n\n\n\n
Deploy the Web Application<\/h2>\n\n\n\n
To deploy the web site you’ll need Web Deploy installed. The latest version for this can be downloaded from here<\/a>, adding the location to the msdeploy.exe executable to the path environment variable.<\/p>\n\n\n\n
To test run the deployment, similar to running a cmdlet with -whatif<\/p>\n\n\n
\nMyAddIn.Web.Deploy.cmd \/T\n<\/pre><\/div>\n\n\n
To perform the deployment:<\/p>\n\n\n
\nMyAddIn.Web.Deploy.cmd \/Y\n<\/pre><\/div>\n\n\n
There are also parameters here to specify the username and password, lots of info in the deploy-readme.txt file.<\/p>\n","protected":false},"excerpt":{"rendered":"
Scripting the creation of SharePoint add-in packages is pretty straight forward. As I found there to be not very many posts on this topic, I thought I’d share how I implemented it. To create and deploy is also easy from … Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"footnotes":""},"categories":[96,3],"tags":[94,21,98,93,100],"class_list":["post-1874","post","type-post","status-publish","format-standard","hentry","category-deployment","category-sharepoint","tag-add-in","tag-deployment","tag-packaging","tag-provider-hosted","tag-sp2019"],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t