Akumina Developer Documentation

Akumina Developer Documentation

  • API
  • Docs
  • Blog

›Azure DevOps

Akumina

  • Quickstart

Modern

  • Overview
  • FAQ
  • Single Page Application
  • Modern Web Part Library
  • Google Analytics for Modern Pages

Widget Builder

  • Widget Builder Structure
  • Akumina Widget Builder
  • Skipping instances
  • Token replacement for widget properties

Virtual Page Builder

  • Akumina Virtual Page Builder
  • Using Virtual Page Layouts

Stream Card Builder

  • Installation
  • Stream Card Builder
  • Custom Cards
  • Activity Comments Config
  • Akumina Activity Stream PUSH Subscription using PowerAutomate to connect to ServiceNow
  • Akumina Activity Stream PUSH Subscription using PowerAutomate to connect to Dynamic 365

Yo Akumina

  • Yo Akumina
  • Start with Yeoman
  • React
  • Simple template

Akumina Widgets

  • Akumina Widgets Overview
  • Building a New Widget
  • Widget Views
  • Widget Properties
  • Global Vs Local widgets
  • Akumina React Widgets
  • Callbacks
  • RenderChildWidgets
  • Vendor Package List

Site Deployer

  • Overview
  • Version 4.8
  • Version 5.0
  • List Attribute Deployments
  • NPM Commands
  • SPA Updates and Deploying to multiple sites
  • Using site deployer with MFA

Headless

  • Quickstart
  • Headless Troubleshooting

Site Creator

  • Overview
  • Adding A Custom Site Definition
  • Core Step Classes
  • Custom Site Definition Components
  • Custom Site Definition XML
  • Custom Subsite Definitions
  • Sample Step Code
  • Supported Tokens

Azure DevOps

  • Setting up a build to deploy a site package
  • Setting up a build to deploy file to App Manager hosted in an app service

Configuration

  • Configuration Context Overview
  • Edit the Redis cache timeout
  • Using a key vault for the client id and client secret

Debugging

  • Debugging in Akumina

Advanced

  • Central Site Collection Support
  • Eventing OOB Digital Workplace Events
  • Working with custom JSX Views
  • Page Indexing

Service Hub

  • Quickstart

Setting up a build to deploy a site package

Applies to

All versions of Akumina

Overview

This article describes how to create a build pipeline to deploy an Akumina Site Deployer package. For more information on a Site Deployer package, please see the References section below.

To create a build

Go into Azure DevOps for the project you want. In our example we will use the code located in the TFS path:

$/BPS/Example/

Go to Pipelines -> Builds. Click New pipeline.

For our example we have code in TFS, so we use the visual designer option.

Select TFVC as the source, and then enter in the TFS path:

In the Build definition, click the plus icon (+) to add under Agent job 1. Then select Command Line from the list.

In the command line option, please enter in the properties for the site deployer. Assuming you placed the site deployer at the root of the build (as instructed to earlier), then the following values will be used:

PropertyValue
Display nameRun Akumina.SiteDeployer
Tool$(Build.SourcesDirectory)\tools\Akumina.SiteDeployer.exe
Argumentsoptions lists envdir "" assetdirectory DigitalWorkplaceCore spdirectory DigitalWorkplace spurl $(siteCollectionUrl) spuser $(siteCollectionUser) sppassword $(siteCollectionPassword)
Reference nameCmdLine1

The options value above indicates what we want to deploy. In our example, we only have lists.

The assetdirectory value above depends on the name of your folder in the /sitedefinitions/ folder. See the Site deployer documentation for more information.

In order to run, the deployer needs variables such as the site collection URl, username and password. We need to add the following:

PropertyDescription
siteCollectionUrlThe site collection URL to deploy to.
siteCollectionUserThe user to be used to connect to the site collection.
siteCollectionPasswordLocked value - The password of the user to be used to connect to the site collection.

Note the siteCollectionPassword value should be LOCKED:

With the actions and the variables saved, we then need to Save. Click Save on the “Save build pipeline” dialog.

Once we save, we can then run the build – go back to builds, and either Run or Queue the build.

We can then separately queue up the build to run later, by returning to Pipelines -> Builds, and clicking the build. We can then queue it via the Queue button.

After the build runs, we will see its status.

And we can see the artifacts deployed into the site collection.

References:

  • Site Deployer: Continuous Site Package Deployment via a console app
  • Site Deployer 4.1
← Supported TokensSetting up a build to deploy file to App Manager hosted in an app service →
Akumina Developer Documentation
Docs
Akumina Framework 5.0Akumina Widget BuilderAkumina Yeoman GeneratorSite Deployer
Community
Akumina Community Site
More
GitHubStar
Copyright © 2022 Akumina