Initialize-DevelopmentEnvironment (initdev)

Description

Builds the ODS/API solution and deploys the necessary databases in order to setup a complete development environment.

Initialize-DevelopmentEnvironment Aliases

  • initdev

Syntax

Initialize-DevelopmentEnvironment [[-InstallType] <String>] [[-OdsTokens] <String[]>] [[-Engine] <String>] [-NoRebuild] [-ExcludeCodeGen] [-NoDeploy] [-RunPester] [-RunDotnetTest] [-RunPostman] [-RunSmokeTest] [-RunSdkGen] [-UsePlugins] [<CommonParameters>]

Parameters

Name

Alias

Description

Required?

Pipeline Input

Default Value

InstallType


The type of deployment to install: 'Sandbox', 'SharedInstance', 'YearSpecific', or 'DistrictSpecific'.

false

false

Sandbox

OdsTokens

OdsYears

A semicolon-separated string which requires single quotes or an array of strings for OdsTokens to use when creating Ods database instances.
Example for Array of Strings in this format @("2018","2019","2020")
Example for semicolon-separated string which requires single quote in this format '2013;2014;2015;2016;2017'
For a year specific deployment a valid value could be '2013;2014;2015;2016;2017'.
For a district specific deployment a valid value could be '255901;255902'.

false

false


Engine


The database engine provider, either "SQLServer" or "PostgreSQL".

false

false

SQLServer

NoRebuild

NoCompile

Skip the Invoke-RebuildSolution task which uses MSBuild to rebuild the main solution file: Ed-Fi-Ods-Implementation/Application/Ed-Fi-Ods.sln.

false

false

False

ExcludeCodeGen

NoCodeGen


false

false

False

NoDeploy


Skip the Initialize-DeploymentEnvironment task which is primarily used to setup developer/production environments. Mainly used by continuous integration.

false

false

False

RunPester


Runs the Invoke-PesterTests task which will run the Pester tests in addition to the other initdev pipeline tasks.

false

false

False

RunDotnetTest


Runs the dotnet tests for the main solution file: Ed-Fi-Ods-Implementation/Application/Ed-Fi-Ods.sln.

false

false

False

RunPostman


Runs the Invoke-PostmanIntegrationTests task which will run the Postman integration tests in addition to the other initdev pipeline tasks.

false

false

False

RunSmokeTest


Runs the Invoke-SmokeTests task which will run the smoke tests, against the in-memory api, in addition to the other initdev pipeline tasks.

false

false

False

RunSdkGen



false

false

False

UsePlugins


Runs database scripts from downloaded plugin extensions in addition to extensions found in the Ed-Fi-Ods-Implementation.

false

false

False