internal/configurations/configuration.ps1
|
<#
This is an example configuration file By default, it is enough to have a single one of them, however if you have enough configuration settings to justify having multiple copies of it, feel totally free to split them into multiple files. #> <# # Example Configuration Set-PSFConfig -Module 'fscps.lcs' -Name 'Example.Setting' -Value 10 -Initialize -Validation 'integer' -Handler { } -Description "Example configuration setting. Your module can then use the setting using 'Get-PSFConfigValue'" #> Set-PSFConfig -Module 'fscps.lcs' -Name 'Import.DoDotSource' -Value $false -Initialize -Validation 'bool' -Description "Whether the module files should be dotsourced on import. By default, the files of this module are read as string value and invoked, which is faster but worse on debugging." Set-PSFConfig -Module 'fscps.lcs' -Name 'Import.IndividualFiles' -Value $false -Initialize -Validation 'bool' -Description "Whether the module files should be imported individually. During the module build, all module code is compiled into few files, which are imported instead by default. Loading the compiled versions is faster, using the individual files is easier for debugging and testing out adjustments." Set-PSFConfig -FullName "fscps.lcs.path.sqlpackage" -Value "C:\Program Files (x86)\Microsoft SQL Server\140\DAC\bin\SqlPackage.exe" -Initialize -Description "Path to the default location where SqlPackage.exe is located." Set-PSFConfig -FullName "fscps.lcs.azure.common.oauth.token" -Value "https://login.microsoftonline.com/common/oauth2/token" -Initialize -Description "URI / URL for the Azure Active Directory OAuth 2.0 endpoint for tokens" Set-PSFConfig -FullName 'fscps.lcs.settings.all.fscpsSettingsFile' -Value 'settings.json' -Initialize -Description 'The name of the file has custom fscps settings. JSON' Set-PSFConfig -FullName 'fscps.lcs.settings.github.runs-on' -Value '' -Initialize -Description 'Specifies which github runner will be used for all jobs in all workflows (except the Update FSC-PS System Files workflow). The default is to use the GitHub hosted runner Windows-latest. You can specify a special GitHub Runner for the build job using the GitHubRunner setting.' Set-PSFConfig -FullName 'fscps.lcs.settings.all.fscPsVer' -Value $script:ModuleVersion -Initialize -Description 'Version of the fscps.lcs module' Set-PSFConfig -FullName 'fscps.lcs.settings.all.currentBranch' -Value '' -Initialize -Description 'The current execution branch name' Set-PSFConfig -FullName 'fscps.lcs.settings.all.sourceBranch' -Value '' -Initialize -Description 'The branch used to build and generate the package.' Set-PSFConfig -FullName 'fscps.lcs.settings.all.repoOwner' -Value '' -Initialize -Description 'The name of the repo owner. GitHub - repo owner. Azure - name of the organization' Set-PSFConfig -FullName 'fscps.lcs.settings.all.repoName' -Value '' -Initialize -Description 'The name of the repo. GitHub - name of the repo. Azure - name of the collection' Set-PSFConfig -FullName 'fscps.lcs.settings.all.repoProvider' -Value '' -Initialize -Description 'GitHub/AzureDevOps/Other' Set-PSFConfig -FullName 'fscps.lcs.settings.all.repositoryRootPath' -Value '' -Initialize -Description 'Dynamics value. Contains the path to the root of the repo' Set-PSFConfig -FullName 'fscps.lcs.settings.all.runId' -Value '' -Initialize -Description 'GitHub/Azure run_id' Set-PSFConfig -FullName 'fscps.lcs.settings.all.repoToken' -Value '' -Initialize -Description '' Set-PSFConfig -FullName 'fscps.lcs.settings.github.githubRunner' -Value 'windows-latest' -Initialize -Description '' Set-PSFConfig -FullName 'fscps.lcs.settings.all.workflowName' -Value '' -Initialize -Description 'The name of the GitHub Workflow/AzureDO Task' Set-PSFConfig -FullName 'fscps.lcs.settings.all.nugetPackagesPath' -Value 'NuGets' -Initialize -Description 'The name of the directory where Nuget packages will be stored' Set-PSFConfig -FullName 'fscps.lcs.settings.github.githubSecrets' -Value '' -Initialize -Description '' Set-PSFConfig -FullName 'fscps.lcs.settings.github.githubAgentName' -Value '' -Initialize -Description 'Specifies which github runner will be used for the build/ci/deploy/release job in workflows. This is the most time consuming task. By default this job uses the Windows-latest github runner ' Set-PSFConfig -FullName 'fscps.lcs.settings.all.lcsEnvironmentId' -Value '' -Initialize -Description 'The Guid of the LCS environment' Set-PSFConfig -FullName 'fscps.lcs.settings.all.lcsProjectId' -Value 123456 -Initialize -Description 'The ID of the LCS project' Set-PSFConfig -FullName 'fscps.lcs.settings.all.lcsClientId' -Value '' -Initialize -Description 'The ClientId of the Azure application what has access to the LCS' Set-PSFConfig -FullName 'fscps.lcs.settings.all.lcsUsername' -Value '' -Initialize -Description 'The GitHub secret name that contains the username that has at least Owner access to the LCS project. It is a highly recommend to create a separate AAD user for this purposes. E.g. lcsadmin@contoso.com' Set-PSFConfig -FullName 'fscps.lcs.settings.all.lcsPassword' -Value '' -Initialize -Description 'The GitHub secret name that contains the password of the LCS user.' Set-PSFConfig -FullName 'fscps.lcs.settings.all.azTenantId' -Value '' -Initialize -Description 'The Guid of the Azure tenant' Set-PSFConfig -FullName 'fscps.lcs.settings.all.azClientId' -Value '' -Initialize -Description 'The Guid of the AAD registered application' Set-PSFConfig -FullName 'fscps.lcs.settings.all.azClientSecret' -Value '' -Initialize -Description 'The github secret name that contains ClientSecret of the registered application' Set-PSFConfig -FullName 'fscps.lcs.settings.all.azVmname' -Value '' -Initialize -Description '' Set-PSFConfig -FullName 'fscps.lcs.settings.all.azVmrg' -Value '' -Initialize -Description '' Set-PSFConfig -FullName 'fscps.lcs.settings.github.repoTokenSecretName' -Value 'REPO_TOKEN' -Initialize -Description '' Set-PSFConfig -FullName 'fscps.lcs.settings.github.secretsList' -Value @('nugetFeedPasswordSecretName','nugetFeedUserSecretName','lcsUsernameSecretname','lcsPasswordSecretname','azClientsecretSecretname','repoTokenSecretName','codeSignDigiCertUrlSecretName','codeSignDigiCertPasswordSecretName','codeSignDigiCertAPISecretName','codeSignDigiCertHashSecretName','codeSignKeyVaultClientSecretName') -Initialize -Description '' Set-PSFConfig -FullName "fscps.lcs.azure.storage.accounts" -Value @{} -Initialize -Description "Object that stores different Azure Storage Account and their details." Set-PSFConfig -FullName "fscps.lcs.active.azure.storage.account" -Value @{} -Initialize -Description "Object that stores the Azure Storage Account details that should be used during the module." |