description: Resource group


key: location

description: Location

type: string

ignoreCase: key


key: templateLocation

description: Template location

ignoreCase: all

enum:
Linked artifact
URL of the file


key: csmFileLink

description: Template link


key: csmParametersFileLink

description: Template parameters link


key: csmFile

description: Template


key: csmParametersFile

description: Template parameters


key: overrideParameters

description: Override template parameters


key: deploymentMode

description: Deployment mode

enum: Incremental Complete Validation


key: enableDeploymentPrerequisites

description: Enable prerequisites


key: teamServicesConnection

description: Azure Pipelines service connection


key: teamProject

description: Team project


key: deploymentGroupName

description: Deployment Group


key: copyAzureVMTags

description: Copy Azure VM tags to agents

type: boolean


key: runAgentServiceAsUser

description: Run agent service as a user


key: userName

description: User name


key: password

description: Password


key: outputVariable

description: VM details for WinRM


key: deploymentName

description: Deployment name


key: deploymentOutputs

description: Deployment outputs


key: addSpnToEnvironment

description: Access service principal details in override parameters


key: task

description:
Invoke REST API

Invoke REST API as a part of your process.

ignoreCase: value


key: inputs

description: Invoke REST API inputs

enum: OPTIONS GET HEAD POST PUT DELETE TRACE PATCH

enum: true false


key: serviceConnection

description: Generic endpoint


key: method

description: Method


key: headers

description: Headers


key: body

description: Body


key: urlSuffix

description: Url suffix string


key: waitForCompletion

description: Complete based on


key: successCriteria

description: Success criteria


description:
Invoke REST API

Invoke a REST API as a part of your pipeline.


description: Invoke REST API inputs

aliases: connectedServiceName genericService


key: connectionType

description: Connection type


description: Generic service connection


key: azureServiceConnection

description: Azure subscription


description: URL suffix and parameters


description: Completion event


description:
Archive Files

Archive files using compression formats such as .7z, .rar, .tar.gz, and .zip.


description: Archive Files inputs

enum: default 7z tar wim

enum: gz bz2 xz none


key: rootFolder

description: Root folder (or file) to archive


key: includeRootFolder

description: Prefix root folder name to archive paths


key: archiveType

description: Archive type


key: tarCompression

description: Tar compression


key: archiveFile

description: Archive file to create


key: replaceExistingArchive

description: Replace existing archive


key: task

description:
Archive files

Compress files into .7z, .tar.gz, or .zip


key: inputs

description: Archive files inputs

enum: zip 7z tar wim

enum: ultra maximum normal fast fastest none


key: rootFolderOrFile

description: Root folder or file to archive


description: Prepend root folder name to archive paths


description: Archive type


key: sevenZipCompression

description: 7z compression


key: verbose

description: Force verbose output


key: quiet

description: Force quiet output


description:
GitHub Comment

Write a comment to your Github entity i.e. issue or a Pull Request (PR)


description: GitHub Comment inputs


key: gitHubConnection

description: GitHub connection (OAuth or PAT)


key: repositoryName

description: Repository


key: id

description: ID of the github pr/issue


key: comment

description: Comment


description:
Copy Files

Copy files from source folder to target folder using minimatch patterns (The minimatch patterns will only match file paths, not folder paths)


description: Copy Files inputs


key: SourceFolder

description: Source Folder


key: Contents

description: Contents


key: TargetFolder

description: Target Folder


key: CleanTargetFolder

description: Clean Target Folder


key: OverWrite

description: Overwrite


key: flattenFolders

description: Flatten Folders


description:
Copy files

Copy files from a source folder to a target folder using patterns matching file paths (not folder paths)


description: Copy files inputs


key: preserveTimestamp

description: Preserve Target Timestamp


key: retryCount

description: Retry count to copy the file


key: delayBetweenRetries

description: Delay between two retries.


key: ignoreMakeDirErrors

description: Ignore errors during creation of target folder.


key: task

description:
Azure Database for MySQL deployment

Run your scripts and make changes to your Azure Database for MySQL


key: inputs

description: Azure Database for MySQL deployment inputs

enum: SqlTaskFile InlineSqlTask

enum: AutoDetect IPAddressRange

required: azureSubscription ServerName SqlUsername SqlPassword


key: azureSubscription

description: Azure Subscription


key: ServerName

description: Host Name


key: DatabaseName

description: Database Name


key: SqlUsername

description: Server Admin Login


key: SqlPassword

description: Password


key: TaskNameSelector

description: Type


key: SqlFile

description: MySQL Script


key: SqlInline

description: Inline MySQL Script


key: SqlAdditionalArguments

description: Additional MySQL Arguments


key: IpDetectionMethod

description: Specify Firewall Rules Using


key: StartIpAddress

description: Start IP Address


key: EndIpAddress

description: End IP Address


key: DeleteFirewallRule

description: Delete Rule After Task Ends


description:
npm

Run an npm command. Use NpmAuthenticate@0 task for latest capabilities.


description: npm inputs


key: cwd

description: working folder


key: command

description: npm command


key: arguments

description: arguments


key: task

description:
npm

Install and publish npm packages, or run an npm command. Supports npmjs.com and authenticated registries like Azure Artifacts.


key: inputs

description: npm inputs

enum: ci install publish custom

enum: useNpmrc useFeed

enum: useExternalRegistry useFeed


description: Command


key: workingDir

description: Working folder that contains package.json


key: verbose

description: Verbose logging


key: customCommand

description: Command and arguments


key: customRegistry

description: Registries to use


key: customFeed

description: Use packages from this Azure Artifacts/TFS registry


key: customEndpoint

description: Credentials for registries outside this organization/collection


key: publishRegistry

description: Registry location


key: publishFeed

description: Target registry


key: publishPackageMetadata

description: Publish pipeline metadata


key: publishEndpoint

description: External Registry


description:
Deploy Azure Static Web App

[PREVIEW] Build and deploy an Azure Static Web App


description: Deploy Azure Static Web App inputs

aliases: cwd rootDirectory

type: integer


key: workingDirectory

description: Working directory


description: App location


description: App build command


description: Output location


description: Api location


description: Api build command


description: Routes location


description: Config file location


description: Skip app build


description: Skip api build


description: Set static export


description: Verbose


description: Build timeout in minutes


description: Azure Static Web Apps api token


description: Deployment Environment


description: Production Branch


description: Data api location


description:
Node.js tool installer

Finds or downloads and caches the specified version spec of Node.js and adds it to the PATH


description: Node.js tool installer inputs

enum: spec fromFile


key: versionSource

description: Source of version


key: versionSpec

description: Version Spec


key: versionFilePath

description: Path to the .nvmrc file


key: checkLatest

description: Check for Latest Version


description: Use 32 bit version on x64 agents


key: nodejsMirror

description: Set source for Node.js binaries


key: task

description:
Use Node.js ecosystem

Set up a Node.js environment and add it to the PATH, additionally providing proxy support


key: inputs

description: Use Node.js ecosystem inputs


key: version

description: Version


description:
[Deprecated] SQL Server database deploy

Deploy a SQL Server database using DACPAC


description: [Deprecated] SQL Server database deploy inputs

enum: Http Https

enum: server connectionString publishProfile

enum: machineNames tags

required: EnvironmentName DacpacFile


key: EnvironmentName

description: Machines


key: AdminUserName

description: Admin Login


key: AdminPassword

description: Password


key: Protocol

description: Protocol


key: TestCertificate

description: Test Certificate


key: DacpacFile

description: DACPAC File


key: TargetMethod

description: Specify SQL Using


key: ServerName

description: Server Name


key: DatabaseName

description: Database Name


key: SqlUsername

description: SQL Username


key: SqlPassword

description: SQL Password


key: ConnectionString

description: Connection String


key: PublishProfile

description: Publish Profile


key: AdditionalArguments

description: Additional Arguments


key: DeployInParallel

description: Deploy in Parallel


key: ResourceFilteringMethod

description: Select Machines By


key: MachineFilter

description: Deploy to Machines


key: task

description:
Visual Studio test platform installer

Acquire the test platform from nuget.org or the tool cache. Satisfies the ‘vstest’ demand and can be used for running tests and collecting diagnostic data using the Visual Studio Test task.


key: inputs

description: Visual Studio test platform installer inputs

enum: nugetOrg customFeed netShare


key: packageFeedSelector

description: Package Feed


key: versionSelector

description: Version


key: testPlatformVersion

description: Test Platform Version


key: customFeed

description: Package Source


key: username

description: User Name


key: password

description: Password


key: netShare

description: UNC Path


description:
Publish To Azure Service Bus

Sends a message to Azure Service Bus using a service connection (no agent is required)


description: Publish To Azure Service Bus inputs


key: azureSubscription

description: Azure Service Bus service connection


key: messageBody

description: Message body


key: sessionId

description: Session Id


key: signPayload

description: Sign the Message


key: certificateString

description: Certificate Variable


key: signatureKey

description: Signature Property Key


key: waitForCompletion

description: Wait for task completion


key: useDataContractSerializer

description: Use .NET data contract serailizer


key: task

description:
Publish To Azure Service Bus

Sends a message to azure service bus using a service connection (no agent required).


key: inputs

description: Publish To Azure Service Bus inputs


description: Azure service bus connection


description:
Deploy to Kubernetes

Use Kubernetes manifest files to deploy to clusters or even bake the manifest files to be used for deployments using Helm charts


description: Deploy to Kubernetes inputs

enum: bake createSecret delete deploy patch promote scale reject

enum: pod smi

enum: helm kompose kustomize

enum: file name

enum: deployment replicaset statefulset

enum: json merge strategic

enum: dockerRegistry generic


key: action

description: Action


key: kubernetesServiceConnection

description: Kubernetes service connection


key: namespace

description: Namespace


key: strategy

description: Strategy


key: trafficSplitMethod

description: Traffic split method


key: percentage

description: Percentage


key: baselineAndCanaryReplicas

description: Baseline and canary replicas


key: manifests

description: Manifests


key: containers

description: Containers


key: imagePullSecrets

description: ImagePullSecrets


key: renderType

description: Render Engine


key: dockerComposeFile

description: Path to docker compose file


key: helmChart

description: Helm Chart


key: releaseName

description: Helm Release Name


key: overrideFiles

description: Override Files


key: overrides

description: Overrides


key: kustomizationPath

description: Kustomization Path


key: resourceToPatch

description: Resource to patch


key: resourceFileToPatch

description: File path


key: kind

description: Kind


key: name

description: Name


key: replicas

description: Replica count


key: mergeStrategy

description: Merge Strategy


key: arguments

description: Arguments


key: patch

description: Patch


key: secretType

description: Type of secret


key: secretName

description: Secret name


key: secretArguments

description: Arguments


key: dockerRegistryEndpoint

description: Docker registry service connection


key: rolloutStatusTimeout

description: Timeout for rollout status


key: task


key: inputs

description: Deploy to Kubernetes inputs


key: action

description: Action


key: connectionType

description: Service connection type


key: kubernetesServiceConnection

description: Kubernetes service connection


key: azureSubscriptionConnection

description: Azure subscription


key: azureResourceGroup

description: Resource group


key: kubernetesCluster

description: Kubernetes cluster


key: namespace

description: Namespace


key: strategy

description: Strategy


key: trafficSplitMethod

description: Traffic split method


key: percentage

description: Percentage


key: baselineAndCanaryReplicas

description: Baseline and canary replicas


key: manifests

description: Manifests


key: containers

description: Containers


key: imagePullSecrets

description: ImagePullSecrets


key: renderType

description: Render Engine


key: dockerComposeFile

description: Path to docker compose file


key: helmChart

description: Helm Chart


key: releaseName

description: Helm Release Name


key: overrideFiles

description: Override Files


key: overrides

description: Overrides


key: kustomizationPath

description: Kustomization Path


key: resourceToPatch

description: Resource to patch


key: resourceFileToPatch

description: File path


key: kind

description: Kind


key: name

description: Name


key: replicas

description: Replica count


key: mergeStrategy

description: Merge Strategy


key: arguments

description: Arguments


key: patch

description: Patch


key: secretType

description: Type of secret


key: secretName

description: Secret name


key: secretArguments

description: Arguments


key: dockerRegistryEndpoint

description: Docker registry service connection


key: rolloutStatusTimeout

description: Timeout for rollout status


key: task

description:
Download build artifacts

Download files that were saved as artifacts of a completed build


key: inputs

description: Download build artifacts inputs

enum: current specific

enum: latest latestFromBranch specific

enum: single specific


key: buildType

description: Download artifacts produced by


key: project

description: Project


key: pipeline

description: Build pipeline


key: specificBuildWithTriggering

description: When appropriate, download artifacts from the triggering build.


key: buildVersionToDownload

description: Build version to download


key: allowPartiallySucceededBuilds

description: Download artifacts even from partially succeeded builds.


key: branchName

description: Branch name


key: buildId

description: Build


key: tags

description: Build Tags


key: downloadType

description: Download type


key: artifactName

description: Artifact name


key: itemPattern

description: Matching pattern


key: downloadPath

description: Destination directory


key: cleanDestinationFolder

description: Clean destination folder


key: parallelizationLimit

description: Parallelization limit


key: checkDownloadedFiles

description: Check downloaded files


key: retryDownloadCount

description: Retry count


key: extractTars

description: Extract all files that are stored inside tar archives


key: task


key: inputs

description: Download build artifacts inputs


key: buildType

description: Download artifacts produced by


key: project

description: Project


key: pipeline

description: Build pipeline


key: specificBuildWithTriggering


key: buildVersionToDownload

description: Build version to download


key: allowPartiallySucceededBuilds


key: branchName

description: Branch name


key: buildId

description: Build


key: tags

description: Build Tags


key: downloadType

description: Download type


key: artifactName

description: Artifact name


key: itemPattern

description: Matching pattern


key: downloadPath

description: Destination directory


key: cleanDestinationFolder

description: Clean destination folder


key: parallelizationLimit

description: Parallelization limit


key: checkDownloadedFiles

description: Check downloaded files


key: retryDownloadCount

description: Retry count


key: extractTars


key: task

description:
CocoaPods

Install CocoaPods dependencies for Swift and Objective-C Cocoa projects


key: inputs

description: CocoaPods inputs


key: workingDirectory

description: Working directory


key: forceRepoUpdate

description: Force repo update


key: projectDirectory

description: Project directory


description:
Azure Spring Cloud

Deploy applications to Azure Spring Cloud and manage deployments.


description: Azure Spring Cloud inputs

enum:
Deploy
Set Production
Delete Staging Deployment

enum: Artifacts CustomContainer


key: azureSubscription

description: Azure subscription


key: Action

description: Action


key: AzureSpringCloud

description: Azure Spring Cloud Name


key: AppName

description: App


key: DeploymentType

description: Deployment Type


key: UseStagingDeployment

description: Use Staging Deployment


key: CreateNewDeployment

description: Create a new staging deployment if one does not exist.


key: DeploymentName

description: Deployment


key: Package

description: Package or folder


key: Builder

description: Builder


key: RegistryServer

description: Registry Server


key: RegistryUsername

description: Registry Username


key: RegistryPassword

description: Registry Password


key: ImageName

description: Image Name and Tag


key: ImageCommand

description: Image Command


key: ImageArgs

description: Image Arguments


key: ImageLanguageFramework

description: Language Framework


key: EnvironmentVariables

description: Environment Variables


key: JvmOptions

description: JVM Options


key: RuntimeVersion

description: Runtime Version


key: DotNetCoreMainEntryPath

description: Main Entry Path


key: Version

description: Version


key: task

description:
Azure Web App

Deploy an Azure Web App for Linux or Windows


key: inputs

description: Azure Web App inputs

enum: webApp webAppLinux

enum: auto zipDeploy runFromPackage

required: azureSubscription appType appName


key: azureSubscription

description: Azure subscription


key: appType

description: App type


key: appName

description: App name


key: deployToSlotOrASE

description: Deploy to Slot or App Service Environment


key: resourceGroupName

description: Resource group


key: slotName

description: Slot


key: package

description: Package or folder


key: customDeployFolder

description: Custom Deploy Folder


key: runtimeStack

description: Runtime stack


key: startUpCommand

description: Startup command


key: customWebConfig

description: Generate web.config parameters for Python, Node.js, Go and Java apps


key: appSettings

description: App settings


key: configurationStrings

description: Configuration settings


key: deploymentMethod

description: Deployment method


description:
Azure CLI

Run Azure CLI commands against an Azure subscription in a Shell script when running on Linux agent or Batch script when running on Windows agent.


description: Azure CLI inputs

enum: inlineScript scriptPath


key: scriptLocation

description: Script Location


key: scriptPath

description: Script Path


key: inlineScript

description: Inline Script


key: arguments

description: Arguments


key: addSpnToEnvironment

description: Access service principal details in script


key: useGlobalConfig

description: Use global Azure CLI configuration


key: workingDirectory

description: Working Directory


key: failOnStandardError

description: Fail on Standard Error


key: task

description:
Azure CLI Preview

Run a Shell or Batch script with Azure CLI commands against an azure subscription


key: inputs

description: Azure CLI Preview inputs


key: connectedServiceNameSelector

description: Azure Connection Type


key: connectedServiceNameARM

description: AzureRM Subscription


key: connectedServiceName

description: Azure Classic Subscription


key: args

description: Arguments


key: cwd

description: Working Directory


description:
Azure CLI

Run Azure CLI commands against an Azure subscription in a PowerShell Core/Shell script when running on Linux agent or PowerShell/PowerShell Core/Batch script when running on Windows agent.


description: Azure CLI inputs

enum: ps pscore batch bash

enum: stop continue silentlyContinue

required: azureSubscription scriptType


key: azureSubscription

description: Azure Resource Manager connection


key: scriptType

description: Script Type


key: scriptLocation

description: Script Location


key: scriptPath

description: Script Path


key: inlineScript

description: Inline Script


key: arguments

description: Script Arguments


key: powerShellErrorActionPreference

description: ErrorActionPreference


key: addSpnToEnvironment


key: useGlobalConfig

description: Use global Azure CLI configuration


key: workingDirectory

description: Working Directory


key: failOnStandardError

description: Fail on Standard Error


key: powerShellIgnoreLASTEXITCODE

description: Ignore $LASTEXITCODE


key: task

description:
GitHub Release

Create, edit, or delete a GitHub release


key: inputs

description: GitHub Release inputs

enum: create edit delete

enum: gitTag userSpecifiedTag

enum: filePath inline

enum: delete replace

enum: commitBased issueBased


key: gitHubConnection

description: GitHub connection (OAuth or PAT)


key: repositoryName

description: Repository


key: action

description: Action


key: target

description: Target


key: tagSource

description: Tag source


key: tagPattern

description: Tag Pattern


key: tag

description: Tag


key: title

description: Release title


key: releaseNotesSource

description: Release notes source


key: releaseNotesFilePath

description: Release notes file path


key: releaseNotesInline

description: Release notes


key: assets

description: Assets


key: assetUploadMode

description: Asset upload mode


key: isDraft

description: Draft release


key: isPreRelease

description: Pre-release


key: addChangeLog

description: Add changelog


key: changeLogCompareToRelease

description: Compare to


key: changeLogCompareToReleaseTag

description: Release Tag


key: changeLogType

description: Changelog type


key: changeLogLabels

description: Categories


key: task


key: inputs

description: GitHub Release inputs

enum: auto manual

enum: file input


key: gitHubConnection

description: GitHub connection (OAuth or PAT)


key: repositoryName

description: Repository


key: action

description: Action


key: target

description: Target


key: tagSource

description: Tag source


key: tagPattern

description: Tag Pattern


key: tag

description: Tag


key: title

description: Release title


key: releaseNotesSource

description: Release notes source


key: releaseNotesFile

description: Release notes file path


key: releaseNotes

description: Release notes


key: assets

description: Assets


key: assetUploadMode

description: Asset upload mode


key: isDraft

description: Draft release


key: isPreRelease

description: Pre-release


key: addChangeLog

description: Add changelog


key: changeLogCompareToRelease

description: Compare to


key: changeLogCompareToReleaseTag

description: Release Tag


key: changeLogType

description: Changelog type


key: changeLogLabels

description: Categories


key: task

description:
cURL Upload Files

Use cURL to upload files with FTP, FTPS, SFTP, HTTP, and more.


key: inputs

description: cURL Upload Files inputs

required: files url


key: files

description: Files


key: username

description: Username


key: password

description: Password


key: url

description: URL


key: options

description: Optional Arguments


key: redirectStderr

description: Redirect Standard Error to Standard Out


description:
cURL upload files

Use cURL's supported protocols to upload files


description: cURL upload files inputs

enum: ServiceEndpoint UserAndPass


key: authType

description: Authentication Method


key: serviceEndpoint

description: Service Connection


key: remotePath

description: Remote Directory


description:
Azure App Service Settings

Update/Add App settings an Azure Web App for Linux or Windows


description: Azure App Service Settings inputs


key: azureSubscription

description: Azure subscription


key: appName

description: App Service name


key: resourceGroupName

description: Resource group


key: slotName

description: Slot


key: appSettings

description: App settings


key: generalSettings

description: General settings


key: connectionStrings

description: Connection Strings


key: task

description:
Universal packages

Download or publish Universal Packages


key: inputs

description: Universal packages inputs

enum: download publish

enum: internal external

enum: major minor patch custom

enum: None Trace Debug Information Warning Error Critical


key: command

description: Command


key: downloadDirectory

description: Destination directory


key: feedsToUse

description: Feed location


key: externalFeedCredentials

description: organization/collection connection


key: vstsFeed

description: Feed


key: vstsFeedPackage

description: Package name


key: vstsPackageVersion

description: Version


key: feedDownloadExternal

description: Feed (or Project/Feed if the feed was created in a project)


key: packageDownloadExternal

description: Package name


key: versionDownloadExternal

description: Version


key: publishDirectory

description: Path to file(s) to publish


key: feedsToUsePublish

description: Feed location


key: publishFeedCredentials

description: organization/collection connection


key: vstsFeedPublish

description: Destination Feed


key: publishPackageMetadata

description: Publish pipeline metadata


key: vstsFeedPackagePublish

description: Package name


key: feedPublishExternal


key: packagePublishExternal

description: Package name


key: versionOption

description: Version


key: versionPublish

description: Custom version


key: packagePublishDescription

description: Description


key: verbosity

description: Verbosity


key: publishedPackageVar

description: Package Output Variable


key: task

description:
Check Azure Policy compliance

Security and compliance assessment for Azure Policy


key: inputs

description: Check Azure Policy compliance inputs


key: azureSubscription

description: Azure subscription


key: ResourceGroupName

description: Resource group


key: Resources

description: Resource name


description:
Azure Function on Kubernetes

Deploy Azure function to Kubernetes cluster.


description: Azure Function on Kubernetes inputs


key: dockerRegistryServiceConnection

description: Docker registry service connection


key: kubernetesServiceConnection

description: Kubernetes service connection


key: namespace

description: Kubernetes namespace


key: secretName

description: Secret Name


key: dockerHubNamespace

description: Docker Hub namespace


key: appName

description: Application Name


key: functionRootDirectory

description: Function root directory


key: waitForStability

description: Wait for stability


key: arguments

description: Arguments


description: Azure Function on Kubernetes inputs

enum:
Azure Resource Manager
Kubernetes Service Connection

required: dockerRegistryServiceConnection appName


key: connectionType

description: Service connection type


key: azureSubscriptionConnection

description: Azure subscription


key: azureResourceGroup

description: Resource group


key: kubernetesCluster

description: Kubernetes cluster


key: task

description:
Bash

Run a Bash script on macOS, Linux, or Windows


key: inputs

description: Bash inputs


key: targetType

description: Type


key: filePath

description: Script Path


key: script

description: Script


key: workingDirectory

description: Working Directory


key: failOnStderr

description: Fail on Standard Error


key: bashEnvValue

description: Set value for BASH_ENV environment variable


description:
Shell script

Run a shell script using Bash


description: Shell script inputs


key: scriptPath

description: Script Path


key: args

description: Arguments


key: disableAutoCwd

description: Specify Working Directory


key: cwd

description: Working Directory


key: failOnStandardError

description: Fail on Standard Error


description:
Publish build artifacts

Publish build artifacts to Azure Pipelines or a Windows file share


description: Publish build artifacts inputs

enum: Container FilePath


key: PathtoPublish

description: Path to publish


key: ArtifactName

description: Artifact name


key: publishLocation

description: Artifact publish location


key: TargetPath

description: File share path


key: Parallel

description: Parallel copy


key: ParallelCount

description: Parallel count


key: FileCopyOptions

description: File copy options


key: StoreAsTar

description: Tar the artifact before uploading


key: task

description:
Install SSH key

Install an SSH key prior to a build or deployment


key: inputs

description: Install SSH key inputs

required: knownHostsEntry sshKeySecureFile


key: knownHostsEntry

description: Known Hosts Entry


key: sshPublicKey

description: SSH Public Key


key: sshPassphrase

description: SSH Passphrase


key: sshKeySecureFile

description: SSH Key


key: addEntryToConfig

description: Add entry to SSH config


key: configHostAlias

description: Alias


key: configHostname

description: Host name


key: configUser

description: User


key: configPort

description: Port


description:
Azure VM scale set deployment

Deploy a virtual machine scale set image


description: Azure VM scale set deployment inputs

enum:
Update image
Configure application startup

enum: Windows Linux

required: azureSubscription vmssName vmssOsType imageUrl


key: azureSubscription

description: Azure subscription


key: action

description: Action


key: vmssName

description: Virtual Machine scale set name


key: vmssOsType

description: OS type


key: imageUrl

description: Image URL


key: customScriptsDirectory

description: Custom script directory


key: customScript

description: Command


key: customScriptArguments

description: Arguments


key: customScriptsStorageAccount

description: Azure storage account where custom scripts will be uploaded


key: skipArchivingCustomScripts

description: Skip Archiving custom scripts


key: task

description:
Azure App Service: Classic (Deprecated)

Create or update Azure App Service using Azure PowerShell


key: inputs

description: Azure App Service: Classic (Deprecated) inputs

required: ConnectedServiceName WebSiteLocation WebSiteName Package


key: ConnectedServiceName

description: Azure Subscription (Classic)


key: WebSiteLocation

description: Web App Location


key: WebSiteName

description: Web App Name


key: Slot

description: Slot


key: Package

description: Web Deploy Package


key: doNotDelete

description: Set DoNotDelete flag


key: AdditionalArguments

description: Additional Arguments


description:
Azure Cloud Service deployment

Deploy an Azure Cloud Service


description: Azure Cloud Service deployment inputs

required: azureClassicSubscription ServiceName ServiceLocation CsPkg CsCfg


key: azureClassicSubscription

description: Azure subscription (Classic)


key: EnableAdvancedStorageOptions

description: Enable ARM storage support


key: StorageAccount

description: Storage account (Classic)


key: ARMConnectedServiceName

description: Azure subscription (ARM)


key: ARMStorageAccount

description: Storage account (ARM)


key: ServiceName

description: Service name


key: ServiceLocation

description: Service location


key: CsPkg

description: CsPkg


key: CsCfg

description: CsCfg


key: slotName

description: Environment (Slot)


key: DeploymentLabel

description: Deployment label


key: AppendDateTimeToLabel

description: Append current date and time


key: AllowUpgrade

description: Allow upgrade


key: SimultaneousUpgrade

description: Simultaneous upgrade


key: ForceUpgrade

description: Force upgrade


key: VerifyRoleInstanceStatus

description: Verify role instance status


key: DiagnosticStorageAccountKeys

description: Diagnostic storage account keys


key: NewServiceCustomCertificates

description: Custom certificates to import


key: NewServiceAdditionalArguments

description: Additional arguments


key: NewServiceAffinityGroup

description: Affinity group


key: task

description:
Cargo authenticate (for task runners)

Authentication task for the cargo client used for installing Cargo crates distribution


key: inputs

description: Cargo authenticate (for task runners) inputs


key: configFile

description: config.toml file to authenticate


key: cargoServiceConnections

description: Credentials for registries outside this organization/collection


description:
Delete files

Delete folders, or files matching a pattern


description: Delete files inputs


key: SourceFolder

description: Source Folder


key: Contents

description: Contents


key: RemoveSourceFolder

description: Remove SourceFolder


key: RemoveDotFiles

description: Remove files starting with a dot


description:
gulp

Run the gulp Node.js streaming task-based build system


description: gulp inputs

enum: Mocha Jasmine


key: gulpFile

description: gulp File Path


key: targets

description: gulp Task(s)


key: arguments

description: Arguments


key: workingDirectory

description: Working Directory


key: gulpjs

description: gulp.js location


key: publishJUnitResults

description: Publish to Azure Pipelines


key: testResultsFiles

description: Test Results Files


key: testRunTitle

description: Test Run Title


key: enableCodeCoverage

description: Enable code Coverage


key: testFramework

description: Test Framework


key: srcFiles

description: Source Files


key: testFiles

description: Test Script Files


key: task

description:
Cloud-based web performance test

Run a quick web performance test in the cloud with Azure Pipelines


key: inputs

description: Cloud-based web performance test inputs

enum:
Default
Australia East
Australia Southeast
Brazil South
Central India
Central US
East Asia
East US 2
East US
Japan East
Japan West
North Central US
North Europe
South Central US
South India
Southeast Asia
West Europe
West US

required: websiteUrl testName


key: connectedServiceName

description: Azure Pipelines Connection


key: websiteUrl

description: Website URL


key: testName

description: Test Name


key: vuLoad

description: User Load


key: runDuration

description: Run Duration (sec)


key: geoLocation

description: Load Location


key: machineType

description: Run load test using


key: resourceGroupName

description: Resource group rig


key: numOfSelfProvisionedAgents

description: No. of agents to use


key: avgResponseTimeThreshold

description: Fail test if Avg.Response Time(ms) exceeds


description:
IIS web app manage

Create or update websites, web apps, virtual directories, or application pools


description: IIS web app manage inputs

enum: IISWebsite IISWebApplication IISVirtualDirectory IISApplicationPool

enum: CreateOrUpdateAppPool StartAppPool StopAppPool RecycleAppPool

enum: https http

enum: Integrated Classic

enum: ApplicationPoolIdentity LocalService LocalSystem NetworkService SpecificUser

enum: VDUserPassThrough VDWindowsAuth

required: WebsiteName Bindings AppPoolNameForWebsite ParentWebsiteNameForVD VirtualPathForVD ParentWebsiteNameForApplication VirtualPathForApplication AppPoolNameForApplication AppPoolName


key: EnableIIS

description: Enable IIS


key: IISDeploymentType

description: Configuration type


key: ActionIISWebsite

description: Action


key: ActionIISApplicationPool

description: Action


key: StartStopWebsiteName

description: Website name


key: WebsiteName

description: Website name


key: WebsitePhysicalPath

description: Physical path


key: WebsitePhysicalPathAuth

description: Physical path authentication


key: WebsiteAuthUserName

description: Username


key: WebsiteAuthUserPassword

description: Password


key: AddBinding

description: Add binding


key: Protocol

description: Protocol


key: IPAddress

description: IP address


key: Port

description: Port


key: ServerNameIndication

description: Server Name Indication required


key: HostNameWithOutSNI

description: Host name


key: HostNameWithHttp

description: Host name


key: HostNameWithSNI

description: Host name


key: SSLCertThumbPrint

description: SSL certificate thumbprint


key: Bindings

description: Add bindings


key: CreateOrUpdateAppPoolForWebsite

description: Create or update app pool


key: ConfigureAuthenticationForWebsite

description: Configure authentication


key: AppPoolNameForWebsite

description: Name


key: DotNetVersionForWebsite

description: .NET version


key: PipeLineModeForWebsite

description: Managed pipeline mode


key: AppPoolIdentityForWebsite

description: Identity


key: AppPoolUsernameForWebsite

description: Username


key: AppPoolPasswordForWebsite

description: Password


key: AnonymousAuthenticationForWebsite

description: Anonymous authentication


key: BasicAuthenticationForWebsite

description: Basic authentication


key: WindowsAuthenticationForWebsite

description: Windows authentication


key: ParentWebsiteNameForVD

description: Parent website name


key: VirtualPathForVD

description: Virtual path


key: PhysicalPathForVD

description: Physical path


key: VDPhysicalPathAuth

description: Physical path authentication


key: VDAuthUserName

description: Username


key: VDAuthUserPassword

description: Password


key: ParentWebsiteNameForApplication

description: Parent website name


key: VirtualPathForApplication

description: Virtual path


key: PhysicalPathForApplication

description: Physical path


key: ApplicationPhysicalPathAuth

description: Physical path authentication


key: ApplicationAuthUserName

description: Username


key: ApplicationAuthUserPassword

description: Password


key: CreateOrUpdateAppPoolForApplication

description: Create or update app pool


key: AppPoolNameForApplication

description: Name


key: DotNetVersionForApplication

description: .NET version


key: PipeLineModeForApplication

description: Managed pipeline mode


key: AppPoolIdentityForApplication

description: Identity


key: AppPoolUsernameForApplication

description: Username


key: AppPoolPasswordForApplication

description: Password


key: AppPoolName

description: Name


key: DotNetVersion

description: .NET version


key: PipeLineMode

description: Managed pipeline mode


key: AppPoolIdentity

description: Identity


key: AppPoolUsername

description: Username


key: AppPoolPassword

description: Password


key: StartStopRecycleAppPoolName

description: Application pool name


key: AppCmdCommands

description: Additional appcmd.exe commands


key: task

description:
Docker CLI installer

Install Docker CLI on agent machine.


key: inputs

description: Docker CLI installer inputs

enum: stable edge test nightly


key: dockerVersion

description: Docker Version


key: releaseType

description: Release type


description:
Global settings
https://github.com/yamnikov-oleg/projektor#configuration

type: object

default: web-browser


key: keybind

description:
A daemon keybinding
https://github.com/yamnikov-oleg/projektor#configuration


key: forcecacheinterval

description:
A delay between daemon run with '-dry' flag
https://github.com/yamnikov-oleg/projektor#configuration


key: enabledcategories

description:
Global enabled category settings
https://github.com/yamnikov-oleg/projektor#configuration


key: calc

description:
Whether to enable calculator
https://github.com/yamnikov-oleg/projektor#configuration


key: history

description:
Whether to show history
https://github.com/yamnikov-oleg/projektor#configuration


key: apps

description:
Whether to show applications
https://github.com/yamnikov-oleg/projektor#configuration


key: url

description:
Whether to show urls
https://github.com/yamnikov-oleg/projektor#configuration


key: commands

description:
Whether to show commands
https://github.com/yamnikov-oleg/projektor#configuration


key: files

description:
Whether to show files
https://github.com/yamnikov-oleg/projektor#configuration


key: websearch

description:
Whether to allow web search
https://github.com/yamnikov-oleg/projektor#configuration


description:
Global history settings
https://github.com/yamnikov-oleg/projektor#configuration


key: capacity

description:
A capacity
https://github.com/yamnikov-oleg/projektor#configuration


description:
Global url settings
https://github.com/yamnikov-oleg/projektor#configuration


description:
An icon
https://github.com/yamnikov-oleg/projektor#configuration


description:
Global web search settings
https://github.com/yamnikov-oleg/projektor#configuration


key: engine

description:
A url template
https://github.com/yamnikov-oleg/projektor#configuration


key: icon

description:
An entry icon
https://github.com/yamnikov-oleg/projektor#configuration


key: ui

description:
Global UI settings
https://github.com/yamnikov-oleg/projektor#configuration


key: width

description:
A width
https://github.com/yamnikov-oleg/projektor#configuration


key: height

description:
A height
https://github.com/yamnikov-oleg/projektor#configuration


key: rule

description:
npm-package-json-lint rule

"off" - turns the rule off
"warning" - turns the rule on as a warning, which doesn't affect the exit code
"error" - turns the rule on as an error, which when triggered generates an exit code of 2

enum: off warning error


key: require-author

description: Require author property.


key: require-bin

description: Require bin property.


key: require-bugs

description: Require bugs property.


key: require-bundledDependencies

description: Require bundledDependencies property.


key: require-config

description: Require config property.


key: require-contributors

description: Require contributors property.


key: require-cpu

description: Require cpu property.


key: require-dependencies

description: Require dependencies property.


key: require-description

description: Require description property.


key: require-devDependencies

description: Require devDependencies property.


key: require-directories

description: Require directories property.


key: require-engines

description: Require engines property.


key: require-files

description: Require files property.


key: require-homepage

description: Require homepage property.


key: require-keywords

description: Require keywords property.


key: require-license

description: Require license property.


key: require-main

description: Require main property.


key: require-man

description: Require man property.


key: require-module

description: Require module property.


key: require-name

description: Require name property.


key: require-optionalDependencies

description: Require optionalDependencies property.


key: require-os

description: Require os property.


key: require-peerDependencies

description: Require peerDependencies property.


key: require-preferGlobal

description: Require preferGlobal property.


key: require-private

description: Require private property.


key: require-publishConfig

description: Require publishConfig property.


key: require-repository

description: Require repository property.


key: require-scripts

description: Require scripts property.


key: require-version

description: Require version property.


key: bin-type

description: Ensure the proper data type is used for bin.


key: bundledDependencies-type

description: Ensure the proper data type is used for bundledDependencies.


key: config-type

description: Ensure the proper data type is used for config.


key: cpu-type

description: Ensure the proper data type is used for cpu.


key: dependencies-type

description: Ensure the proper data type is used for dependencies.


key: description-type

description: Ensure the proper data type is used for description.


key: devDependencies-type

description: Ensure the proper data type is used for devDependencies.


key: directories-type

description: Ensure the proper data type is used for directories.


key: engines-type

description: Ensure the proper data type is used for engines.


key: files-type

description: Ensure the proper data type is used for files.


key: homepage-type

description: Ensure the proper data type is used for homepage.


key: keywords-type

description: Ensure the proper data type is used for keywords.


key: license-type

description: Ensure the proper data type is used for license.


key: main-type

description: Ensure the proper data type is used for main.


key: man-type

description: Ensure the proper data type is used for man.


key: name-type

description: Ensure the proper data type is used for name.


key: optionalDependencies-type

description: Ensure the proper data type is used for optionalDependencies.


key: os-type

description: Ensure the proper data type is used for os.


key: peerDependencies-type

description: Ensure the proper data type is used for peerDependencies.


key: preferGlobal-type

description: Ensure the proper data type is used for preferGlobal.


key: private-type

description: Ensure the proper data type is used for private.


key: repository-type

description: Ensure the proper data type is used for repository.


key: scripts-type

description: Ensure the proper data type is used for scripts.


key: version-type

description: Ensure the proper data type is used for version.


key: valid-values-author

description: Requires author to equal one of the supplied values.


key: valid-values-engines

description: Requires engines to equal one of the supplied values.


key: valid-values-license

description: Requires license to equal one of the supplied values.


key: valid-values-name-scope

description: Requires the scope used for the name to equal one of the supplied values.


key: valid-values-private

description: Requires private to equal one of the supplied values.


key: valid-values-publishConfig

description: Requires publishConfig to equal one of the supplied values.


key: no-absolute-version-dependencies

description: Restrict dependencies from specifying an absolute version.


key: no-caret-version-dependencies

description: Restrict dependencies from using caret version syntax.


key: no-restricted-dependencies

description: Restrict a list of dependencies.


key: no-restricted-pre-release-dependencies

description: Restrict listed dependencies from using pre-release versions.


key: no-tilde-version-dependencies

description: Restrict dependencies from using tilde version syntax.


key: prefer-no-version-zero-dependencies

description: Restrict dependencies from specifying version 0.x.x modules.


key: prefer-absolute-version-dependencies

description: Require all dependencies to use absolute versions.


key: prefer-caret-version-dependencies

description: Require all dependencies to use caret version syntax.


key: prefer-tilde-version-dependencies

description: Require all dependencies to use tilde version syntax.


key: prefer-alphabetical-dependencies

description: Require dependencies to be listed in alphabetical order.


key: no-absolute-version-devDependencies

description: Restrict devDependencies from specifying an absolute version.


key: no-caret-version-devDependencies

description: Restrict devDependencies from using caret version syntax.


key: no-restricted-devDependencies

description: Restrict a list of devDependencies.


Restrict listed devDependencies from using pre-release versions.


key: no-tilde-version-devDependencies

description: Restrict devDependencies from using tilde version syntax.


key: prefer-no-version-zero-devDependencies

description: Restrict devDependencies from specifying version 0.x.x modules.


key: prefer-absolute-version-devDependencies

description: Require all devDependencies to use absolute versions.


key: prefer-caret-version-devDependencies

description: Require all devDependencies to use caret version syntax.


key: prefer-tilde-version-devDependencies

description: Require all devDependencies to use tilde version syntax.


key: prefer-alphabetical-devDependencies

description: Require devDependencies to be listed in alphabetical order.


key: prefer-alphabetical-bundledDependencies

description: Require bundledDependencies to be listed in alphabetical order.


Require optionalDependencies to be listed in alphabetical order.


key: prefer-alphabetical-peerDependencies

description: Require peerDependencies to be listed in alphabetical order.


key: description-format

description: Require description formatting rules, such as: requiring the first letter be capitalized and/or ending with a period.


key: name-format

description: Require name to be lowercase.


key: version-format

description: Require version to follow semver.


key: prefer-property-order

description: Require all package.json properties to be in a specified order.


key: prefer-no-engineStrict

description: Ensure engineStrict is not present in package.json file.


key: extends

description: Use the extends property to inherit rules from a shared configuration file/module.

type: string array


key: rules

description: npm-package-json-lint rules are configurable. Use the rules object to specify what rules should be used and what severity level they should follow.


key: cwd

description: The directory from which bower should run. All relative paths will be calculated according to this setting.


key: directory


key: json

description: A file path to the Bower configuration file


key: registry

description: The registry config

type: string object

format: uri

type: array string


key: search

description: An array of URLs pointing to read-only Bower registries. A string means only one. When looking into the registry for an endpoint, Bower will query these registries by the specified order.


key: register

description: The URL to use when registering packages.


key: publish

description: The URL to use when publishing packages.


key: proxy

description: The proxy to use for http requests.


key: https-proxy

description: The proxy to use for https requests.


key: user-agent

description: Sets the User-Agent for each request made.


key: timeout

description: The timeout to be used when making requests in milliseconds.

type: number


key: strict-ssl

description: Whether or not to do SSL key validation when making requests via https.


key: ca

description: The CA certificates to be used, defaults to null. This is similar to the registry key, specifying each CA to use for each registry endpoint.

type: object string


key: color

description: Enable or disable use of colors in the CLI output.


key: storage

description: Where to store persistent data, such as cache, needed by bower.


key: tmp

description: Where to store temporary files and folders


key: interactive

description: Makes bower interactive, prompting whenever necessary


key: resolvers

description: Identifies pluggable resolvers to be used for locating and fetching packages

type: array


key: shallowCloneHosts

description: Whitelists hosts which are known to support shallow cloning


key: scripts

description: Contains custom hooks used to trigger other automated tools


key: preinstall

description: A script to run before install


key: postinstall

description: A script to run after install


key: preuninstall

description: A script to run before uninstall


key: ignoredDependencies

description: Bower will ignore these dependencies when resolving packages


description: A bot that helps onboarding new open-source contributors.


key: labels

description: Sets the labels if "first-timers-only" is not what you are looking for.


key: template

description: The path to your template, relative from the repository root.


key: repository

description: Specify a different repository than where the problem is. The bot must be installed on the configured repository.


description: Configuration file schema for Tye.

enum: docker podman

required: name value

required: name azureFunction

required: name executable

required: name repository

required: name include

required: name image

required: name dockerFile


key: name

description: The application name.


key: registry

description: Dockerhub username or hostname of remote registry. Used for tagging images.


key: containerEngine

description: Container engine.


key: namespace

description: The Kubernetes namespace to use.


key: network

description: The Docker network to use.


key: dashboardPort

description: Configure the dashboard port used for `tye run`. Can be overridden using the `--port` CLI argument, and falls back to port 8000 if free, or a random port if 8000 is in use.


key: ingress

description: The application's ingresses.


key: extensions

description: Extensions to be added to tye.


key: solution

description: Indicates the solution file (.sln) or filter (.slnf) to use when building project-based services in watch mode. If omitted, those services will be built individually. Specifying the solution [filter] can help reduce repeated builds of shared libraries when in watch mode.


key: services

description: The application's services.


description: The binding name.


key: port

description: The binding port.


key: containerPort

description: The port used when running inside a container.


key: host

description: The hostname for the binding.


key: protocol

description: The protocol used by the binding


key: autoAssignPort

description: Whether to auto-assign a port value.


key: connectionString

description: The connection string.


description: Environment variable name.


key: value

description: Environment variable value.


key: name

description: Build property name.


description: Build property name.


description: A named volume.


key: source

description: The local path.


key: target

description: The destination path within the container.


description: The service name. Must be unique per-application.


key: azureFunction

description: The directory path to the azure function.


key: env

description: Environment variables to use when launching.


key: args

description: Command-line arguments to use when launching.


key: replicas

description: Number of service replicas to create.


key: bindings

description: The bindings provided by the service.


key: pathToFunc

description: Optional path to the function host to be used when launching functions. Can point to either func.dll or the binary.


key: executable

description: The file path (or file name if on the system path) of an executable.


key: workingDirectory

description: The working directory to use when launching.


key: external

description: Designates as service as external. External services will not be launched and can only provide bindings.


key: repository

description: The repository url which will be cloned.


key: cloneDirectory

description: The directory to clone the repository into.


key: include

description: Path to tye.yaml file which will be used in the application.


key: volumes

description: Volumes to mount to the container.


key: image

description: The name of a Docker image.


key: dockerFile

description: The Dockerfile to use.


key: dockerFileArgs

description: Build arguments to use when building the image.


key: dockerFileContext

description: The Dockerfile context to run docker build on.


key: name

description: The ingress name.


description: Bindings for the ingress in local development.


key: rules

description: Rules for ingress routing.


description: The binding name.


key: port

description: The binding port.


key: protocol

description: The protocol used by the binding


key: ip

description: The ip address the ingress listens on.


key: service

description: The service to route traffic when the rule matches.


key: path

description: The path prefix to match.


key: host

description: The hostname to match.


key: preservePath

description: Whether to keep the path that was originally present or not after a prefix match.


key: project

description: The relative path to a .NET project file.


key: env


key: buildProperties

description: Build properties to use when launching or building a project.


key: args


key: build

description: Whether to build the project.


key: replicas

description: Number of service replicas to create.


key: bindings

description: The bindings provided by the service.


description: Extension name.


key: workspace

description: A workspace definition


key: profile

description: A profile definition


key: table

description: A table definition


key: classifier

description: A classifier definition


key: function

description: A function definition


key: plugin

description: A plugin definition


key: Workspace

description: A workspace is a collection of one or more catalogs, schemas, tables, and resources, called workspace members, that are managed together.

required: edition name


key: edition

description: The SDF edition, should always be 1 (for now)


key: name

description: The name of this workspace (defaults to the workspace directory name if not given) Name must be set for deployment.


key: description

description: A description of this workspace


key: repository

description: The URL of the workspace source repository [defaults to 'none' if no repository is given]


key: remote-location

description: The default output object store location, e.g. 's3://bucket/key/' where key is optional


key: includes

description: An array of directories and filenames containing .sql and .sdf.yml files


key: excludes

description: An array of directories and filenames to be skipped when resolving includes


key: references

description: An array of paths to other workspaces, i.e. .sql and .yml files


key: dialect

description: The dialect of this workspace. If not set, defaults to sdf dialect


key: resources

description: An array of paths to directories and files, which will be copied to the SDF service on deployment


key: default-catalog

description: Defines a default catalog [If not set, defaults to the directory of the workspace]


key: default-schema

description: Defines a default schema [If not set, defaults to 'pub']


key: default-profile

description: Defines the default profile [if not set, defaults to 'dbg']


key: source-locations

description: Workspace defined by these set of files


key: variables

description: An array of named values for setting SQL variables from your environment Ex. -dt: dt, used in SQL as @dt


key: code-reports

description: An array of queries over the information schema that will be run on sdf describe and sdf deploy


key: code-checks


key: access-control

description: An array of attribute based access control queries over the information schema, current user and current job, that will be run on sdf build and sdf deploy


key: IncludePath

description: All file path should either be relative to the workspace, or absolute for an object store like AWS s3:// Note that an [IncludePath] specifies a catalog and schema scope for unqualified names (in effect for both creating and querying tables). See [IncludePath::default_catalog] and [IncludePath::default_schema].


key: path

description: A filepath


description: Defines a default catalog for unqualified names. If not set, defaults to the [Workspace] catalog.


description: Defines a default schema for unqualified names. If not set, defaults to the [Workspace] schema.


description: The dialect of the included files. If not set, defaults to the [Workspace] dialect.


key: time

description: Last modified of the file


key: FilePath

description: All file path should either be relative to the workspace, or absolute for an object store like AWS s3://


description: The relative path from this workspace to the referenced workspace, for a Git repo, from the root of the depot to the workspace


key: git

description: The Git repo


key: rev

description: the Git revision


key: branch

description: the Git branch


key: Variable

description: SQL queries can be parameterized via variables of type varchar. A variable definition binds the variable to the provided value.


key: name

description: The name of the variable


key: value

description: The value of this variable (using sql/yaml literals)


description: Name of check (default filestem of path)


key: description

description: A description of this report


key: dialect

description: dialect


key: assert

description: Assertion


description: A filepath


description: A description of this assertion


key: access

description: Grant access


description: A description of this access control rule


description: A filepath to a policy authored in .sql


key: Profile

description: Profiles provide a way to override the fields of a workspace, i.e. if a profile has set field X, then the workspace field X will be overridden by the profile field X.


description: A description of this workspace


key: remote-location

description: The default output object store location, e.g. 's3://bucket/key/' where key is optional


key: includes

description: An array of directories and filenames containing .sql and .sdf.yml files


key: excludes

description: An array of directories and filenames to be skipped when resolving includes


key: references

description: An array of paths to other workspaces, i.e. .sql and .yml files


description: The default dialect of this workspace. If not set, defaults to sdf dialect


key: resources

description: An array of paths to directories and files, which will be copied to the SDF service on deployment


key: default-catalog

description: Defines a default catalog [If not set, defaults to the directory of the workspace]


key: default-schema

description: Defines a default schema [If not set, defaults to 'pub']


key: source-locations

description: Workspace defined by these set of files


key: variables

description: An array of named values for setting SQL variables from your environment Ex. -dt: dt, used in SQL as @dt


key: code-reports

description: An array of queries over the information schema that will be run on sdf describe and sdf deploy


key: code-checks


key: access-control

description: An array of attribute based access control queries over the information schema, current user and current job, that will be run on sdf build and sdf deploy


key: Table

description: A tables is either defined by given data (also called external table) or defined via a query.


key: dialect

description: An array of sql file names [Typically inferred]


key: dependencies

description: ALl table dependencies (syntax: catalog.schema.table)


key: columns

description: The columns of the schema: name, type, metadata


key: partitioned-by

description: The partitioning format of the table


key: schedule

description: The schedule of the table [expressed as cron]


key: starting

description: The first date of the table [expressed by prefixes of RFC 33]


key: classifiers

description: An array of classifier references


key: reclassify

description: Array of reclassify instructions for changing the attached classifier labels


key: lineage

description: Lineage, a tagged array of column references


key: materialization

description: The materialization scheme of this table


key: insert-into

description: Store data under this catalog.schema.table instead of the original name


key: location

description: Data is at this location


key: file-format

description: Store table in this format [only for external tables]


key: with-header

description: CSV data has a header [only for external tables]


key: delimiter

description: CSV data is separated by this delimiter [only for external tables]


key: compression

description: Json or CSV data is compressed with this method [only for external tables]


key: source-locations

description: Table is defined by these .sql and/or .sdf files


key: name

description: The name of the column


key: description

description: A description of this column


key: datatype

description: The type of this column


key: nullable

description: The type of this column


key: copy

description: The output column is computed by copying these upstream columns


key: modify

description: The output column is computed by transforming these upstream columns


key: scan

description: These upstream columns are indirectly used to produce the output (e.g. in WHERE or GROUP BY)


key: apply

description: These functions were used to produce the output column


key: to

description: Target classifier


key: from

description: Expected source classifier


key: Partition

description: A partition is a table column, used to describe to which partition this row belongs to


description: The name of the partition column


description: A description of the partition column


key: format

description: The format of the partition column [use strftime format for date/time] See (guide)[https://docs.sdf.com/guide/schedules]


key: Materialization

description: All derived tables are cached by default


description: External tables must be explicitly marked When using 'Create external table` SQL syntax


description: View


description: Ephemeral


description: Recursive warehouse tables must be  explicitly  marked


key: FileFormat

description: Store table data in these formats

enum: parquet csv json


key: CompressionType

description: Compress table data using these methods

enum: tar zstd


description: BZIP2 Compression (.bz2)


description: GZIP Compression (.gzip)


description: None, (default)


key: Classifier

description: A classifier defines the labels that can be attached to columns or a table.


description: The name of the classifier type


description: A description of this classifier type


key: labels

description: Named classifier labels


key: scope

description: scope of the classifier: table or column


key: cardinality

description: cardinality of the classifier: zero-or-one, one or zero-or-many


key: propagate

description: does the classifier propagate from scope to scope or is it a one scope marker


key: source-locations

description: Classifier defined by these set of .sdf files


key: Label

description: A classifier element is a scoped classifier label (e.g. the element PII belongs to the classifier scope data)


key: name

description: The name of the label, use "*" to allow arbitrary strings as labels


key: description

description: A description of this classifier element


key: Function

description: A function block defines the signature for user defined


description: The name of the function [syntax: [[catalog.]schema].function]


key: section

description: The generic type bounds


key: dialect

description: The dialect that provides this function


description: A description of this function


key: variadic

description: Arbitrary number of arguments of an common type out of a list of valid types


key: kind

description: The function kind


key: parameters

description: The arguments of this function


key: optional-parameters

description: The arguments of this function


key: returns

description: The results of this function (can be a tuple)


key: binds

description: The generic type bounds


key: volatility

description: volatility - The volatility of the function.


key: examples

description: example - Example use of the function (tuple with input/output)


key: cross-link

description: cross-link - link to existing documentation, for example: https://prestodb.io/docs/current/functions/datetime.html#truncation-function


key: reclassify

description: Array of reclassify instructions for changing the attached classifier labels


key: source-locations

description: Function defined by these set of .sdf files


key: Variadic


description: All arguments have the same types


description: All even arguments have one type, odd arguments have another type


key: Parameter

description: A function parameter


key: name

description: The name of the parameter


key: description

description: A description of this parameter


key: datatype

description: The datatype of this parameter


key: nullable

description: The nullability of this column


key: classifier

description: An array of classifier references


key: constant

description: The required constant value of this parameter


key: identifiers

description: The parameter may appear as identifier, without quote


key: OptionalParameter

description: A function parameter

required: datatype name


description: The name of the parameter


description: The datatype of this parameter


key: Volatility

description: A function's volatility, which defines the functions eligibility for certain optimizations


description: Pure - An pure function will always return the same output when given the same input.


description: Stable - A stable function may return different values given the same input across different queries but must return the same value for a given input within a query.


description: Volatile - A volatile function may change the return value from evaluation to evaluation. Multiple invocations of a volatile function may return different results when used in the same query.


key: input

description: The sql string corresponding to the input of this example


key: output

description: The output corresponding to running the input string


key: Plugin

description: A function block defines the signature for user defined

required: binary extension format name


description: The name of the plugin [e.g.: pyspark]


key: binary

description: Full path to the binary [e.g.: /usr/bin/python3]


key: extension

description: File extension to scan in the includes directories; must be unique [e.g.: .py]


key: format

description: Format of the output files; must be known to SDF [e.g.: spark-lp-json]


description: Detailed explanation of what this option does. It should be written in full sentences.


key: option-name

description: The name of the option/argument.


description: JSON schema for the Stryker Mutator configuration file

default: npm test

enum: off fatal error warn info debug trace

tsEnumNames: Off Fatal Error Warning Information Debug Trace

enum: off all perTest

enum: full mutationScore

tsEnumNames: Full MutationScore

default: full

default: reports/mutation/events

examples:
tsc -b
babel src --out-dir lib
npm run build

default: perTest

default: off

default: info

enum: npm yarn pnpm

default: clear-text progress html

default: .stryker-tmp

default: command


key: command

description: The command to test each mutant. For example "npm run mocha". Defaults to "npm test".


key: allowColor

description: Indicates whether or not to use color coding in output.


key: allowEmojis

description: Enable emojis in your clear text report (experimental).


key: logTests

description: Indicates whether or not to log which tests were executed for a given mutant.


key: maxTestsToLog

description: Indicates the maximum amount of test to log when `logTests` is enabled


key: project

description: Indicates which project to use if the "dashboard" reporter is enabled.


key: version

description: Indicates which version to use if the "dashboard" reporter is enabled.


key: module

description: Indicates which module to use if the "dashboard" reporter is enabled.


key: baseUrl

description: Indicates the base url of the stryker dashboard.


key: reportType

description: Indicates wether to send a full report (inc. source code and mutant results) or only the mutation score.


key: baseDir

description: The base dir to write the events to


key: fileName

description: The `fileName` of the html report.


description: The relative filename for the json report.


key: plugins

description: Override the default babel plugins Stryker uses to parse your JavaScript files. The default list of plugins is extensive and normally doesn't need overriding. Stryker also loads your babel plugins by default (if you have them). If Stryker's default babel plugins conflicts with your plugins, try to override this list with an empty array.


key: unknownOptions

description: decide whether or not to log warnings when additional stryker options are configured


key: preprocessorErrors

description: decide whether or not to log warnings when a preprocessor error occurs. For example, when the disabling of type errors fails.


key: unserializableOptions

description: decide whether or not to log warnings when a configuration options are unserializable. For example, using a `/regex/` or `function` in your configuration options.


key: slow

description: decide whether or not to log warnings when Stryker detects a slow part of mutation that can be sped up by changing some configuration. For example using `--ignoreStatic`.


key: allowConsoleColors

description: The 'allowConsoleColors' value indicates whether Stryker should use colors in console.


key: buildCommand

description: Configure a build command to run after mutating the code, but before mutants are tested. This is generally used to transpile your code before testing. Only configure this if your test runner doesn't take care of this already and you're not using just-in-time transpiler like `babel/register` or `ts-node`.


key: checkers

description: Enable checker plugins here. A checker plugin will be invoked for each mutant before it is run in a test runner. It can check to see of a given mutant is valid, by for example validate that it won't result in a type error


key: checkerNodeArgs

description: Configure arguments to be passed as exec arguments to the checker child process(es). For example, running Stryker with `--concurrency 1 --checkerNodeArgs --inspect-brk` will allow you to debug the checker child process. See `execArgv` of [`child_process.fork`](https://nodejs.org/api/child_process.html#child_process_child_process_fork_modulepath_args_options)


key: concurrency

description: Set the concurrency of workers. Stryker will always run checkers and test runners in parallel by creating worker processes (note, not `worker_threads`). This defaults to `n-1` where `n` is the number of logical CPU cores available on your machine, unless `n <= 4`, in that case it uses `n`. This is a sane default for most use cases.


key: commandRunner

description: Options used by the command test runner. Note: these options will only be used when the command test runner is activated (this is the default)


key: coverageAnalysis

description:
Indicates which coverage analysis strategy to use. During mutation testing, Stryker will try to only run the tests that cover a particular mutant.

'perTest': Analyse coverage per test.
'all': Analyse the coverage for the entire test suite.
'off' (default): Don't use coverage analysis


key: clearTextReporter

description: The options for the clear text reporter.


key: dashboard

description: The options for the dashboard reporter.


key: dryRunOnly

description: Execute the initial test run only without doing actual mutation testing. Dry run only will still mutate your code before doing the dry run without those mutants being active, thus can be used to test that StrykerJS can run your test setup. This can be useful, for example, in CI pipelines.


key: eventReporter

description: The options for the event recorder reporter.


key: ignorePatterns

description: A comma separated list of patterns used for specifying which files need to be ignored. This should only be used in cases where you experience a slow Stryker startup, because too many (or too large) files are copied to the sandbox that are not needed to run the tests. For example, image or movie directories. Note: This option will have NO effect when using the `--inPlace` option. The directories `node_modules`, `.git` and some others are always ignored. Example: `--ignorePatterns dist`. These patterns are ALWAYS ignored: [`node_modules`, `.git`, `/reports`, `*.tsbuildinfo`, `/stryker.log`, `.stryker-tmp`]. Because Stryker always ignores these, you should rarely have to adjust the `ignorePatterns` setting at all. This is useful to speed up Stryker by ignoring big directories/files you might have in your repo that has nothing to do with your code. For example, 1.5GB of movie/image files. Specify the patterns to all files or directories that are not used to run your tests and thus should NOT be copied to the sandbox directory for mutation testing. Each patterns in this array should be a [glob pattern](#usage-of-globbing-expressions-on-options). If a glob pattern starts with `/`, the pattern is relative to the current working directory. For example, `/foo.js` matches to `foo.js` but not `subdir/foo.js`. However to SELECT specific files TO BE mutated, you better use `--mutate`.


key: ignoreStatic

description: Ignore static mutants. Static mutants are mutants which are only executed during the loading of a file. This means that Stryker has to reload the entire environment in order to test the mutant AND has to run all tests. Therefore, it might make sense to ignore static mutants.


key: incremental

description: Enable 'incremental mode'. Stryker will store results in a file and use that file to speed up the next --incremental run


key: incrementalFile

description: Specify the file to use for incremental mode.


key: force

description: Run all mutants, even if --incremental is provided and an incremental file exists. Can be used to force a rebuild of the incremental file.


key: fileLogLevel

description: Set the log level that Stryker uses to write to the "stryker.log" file


key: inPlace

description:
Determines whether or not Stryker should mutate your files in place. Note: mutating your files in place is generally not needed for mutation testing, unless you have a dependency in your project that is really dependent on the file locations (like "app-root-path" for example).

When `true`, Stryker will override your files, but it will keep a copy of the originals in the temp directory (using `tempDirName`) and it will place the originals back after it is done. Also with `true` the `ignorePatterns` has no effect any more.

When `false` (default) Stryker will work in the copy of your code inside the temp directory.


key: logLevel

description: Set the log level that Stryker uses to write to the console.


key: maxConcurrentTestRunners

description: [DEPRECATED please use "concurrency" instead]. Specifies the maximum number of concurrent test runners to spawn. Mutation testing is time consuming. By default, Stryker tries to make the most of your CPU's, by spawning as many test runners as you have CPU cores (`Number.MAX_SAFE_INTEGER`).


key: maxTestRunnerReuse

description: Restart each test runner worker process after `n` runs. Not recommended unless you are experiencing memory leaks that you are unable to resolve. Configuring `0` here means infinite reuse.


key: mutate

description:
With `mutate` you configure the subset of files or just one specific file to be mutated. These should be your _production code files_, and definitely not your test files.
(Whereas with `ignorePatterns` you prevent non-relevant files from being copied to the sandbox directory in the first place)
The default will try to guess your production code files based on sane defaults. It reads like this:
- Include all js-like files inside the `src` or `lib` dir
- Except files inside `__tests__` directories and file names ending with `test` or `spec`.
If the defaults are not sufficient for you, for example in a angular project you might want to
 **exclude** not only the `*.spec.ts` files but other files too, just like the default already does.
It is possible to specify exactly which code blocks to mutate by means of a _mutation range_. This can be done postfixing your file with `:startLine[:startColumn]-endLine[:endColumn]`. Example: src/index.js:1:3-1:5


key: mutator

description: Configure how Stryker mutates your code.


key: packageManager

description: The package manager Stryker can use to install missing dependencies.


key: plugins

description: With 'plugins', you can add additional Node modules for Stryker to load (or require). By default, all node_modules starting with @stryker-mutator/* will be loaded, so you would normally not need to specify this option. These modules should be installed right next to stryker. For a current list of plugins, you can consult 'npm' or 'stryker-mutator.io.'


key: appendPlugins

description: A list of additional plugins you want Stryker to load (`require`) without overwriting the (default) `plugins`.


key: reporters

description: With reporters, you can set the reporters for stryker to use.


key: htmlReporter

description: The options for the html reporter


key: jsonReporter

description: The options for the json reporter


key: disableTypeChecks

description: Set to 'true' to disable type checking, or 'false' to enable it. For more control, configure a pattern that matches the files of which type checking has to be disabled. This is needed because Stryker will create (typescript) type errors when inserting the mutants in your code. Stryker disables type checking by inserting `// @ts-nocheck` atop those files and removing other `// @ts-xxx` directives (so they won't interfere with `@ts-nocheck`). The default setting allows these directives to be stripped from all JavaScript and friend files in `lib`, `src` and `test` directories.


key: symlinkNodeModules

description: The 'symlinkNodeModules' value indicates whether Stryker should create a symbolic link to your current node_modules directory in the sandbox directories. This makes running your tests by Stryker behave more like your would run the tests yourself in your project directory. Only disable this setting if you really know what you are doing.


key: tempDirName

description: Choose a different temp dir that Stryker uses for mutation testing. This directory will contain copies of your source code during a mutation test run. It will be created if it not exists and is *entirely deleted* after a successful run, so change this with caution.


key: cleanTempDir

description:
Choose whether or not to clean the temp dir (which is ".stryker-tmp" inside the current working directory by default).
 - false: Never delete the temp dir;
 - true: Delete the tmp dir after a successful run;
 - "always": Always delete the temp dir, regardless of whether the run was successful.


key: testRunner

description: With 'testRunner' you specify the test runner that Stryker uses to run your tests. The default value is command. The command runner runs a configurable bash/cmd command and bases the result on the exit code of that program (0 for success, otherwise failed). You can configure this command via the config file using the 'commandRunner: { command: 'npm run mocha' }'. It uses 'npm test' as the command by default.


key: testRunnerNodeArgs

description: Configure arguments to be passed as exec arguments to the test runner child process. For example, running Stryker with `--timeoutMS 9999999 --concurrency 1 --testRunnerNodeArgs --inspect-brk` will allow you to debug the test runner child process. See `execArgv` of [`child_process.fork`](https://nodejs.org/api/child_process.html#child_process_child_process_fork_modulepath_args_options)


key: thresholds

description: Specify the thresholds for mutation score.


key: timeoutFactor

description: Configure the allowed timeout deviation relative to the time of a normal test run. Tweak this if you notice that mutants are prone to creating slower code, but not infinite loops (for that, use `timeoutMS`)


key: timeoutMS

description: Configure an absolute timeout deviation. Tweak this if you run Stryker on a busy machine and you need to wait longer to make sure that the code indeed entered an infinite loop.


key: dryRunTimeoutMinutes

description: Configure an absolute timeout for the initial test run. (It can take a while, therefore we use minutes as time unit.)


key: tsconfigFile

description: Configure the (root) tsconfig file for typescript projects. This will allow Stryker to rewrite the `extends` and `references` settings in this and related tsconfig files in your sandbox. Defaults to `tsconfig.json`. This setting is also used when you enable the `@stryker-mutator/typescript-checker plugin


key: warnings

description: Enable or disable certain warnings


key: disableBail

description: Disables the default of bailing after first failing test. When true runs all tests covering a mutant. Useful when the subject under test is not completely isolated by mocks and you want to know which tests are killing the mutants. This will impact performance.


key: allowEmpty

description: Allows stryker to exit without any errors in cases where no tests are found


description: Schema for image sprite generation files

type: string number

enum: lossless lossy none

default: lossless

enum: horizontal vertical

default: vertical

enum: none css less scss styl


key: customstyles

description: Define custom CSS declarations to inject into the generated stylesheet.


key: additionalProperties

description: A custom CSS declaration (property: value).


key: dpi

description: The image resolution of the generated image sprite


key: images

description: An array of file paths relative to this document. The name must be unique.


description: A source image for the sprite.


key: optimize

description: Optimizes the generated image either lossy or lossless. Requires the "Image Optimizer" extension for Visual Studio


key: orientation

description: The orientation of the individual images inside the generated sprite.


key: output

description: Output format of the generated image sprite.

enum: png jpg gif

default: png


key: padding

description: The padding arround each individual image in the sprite. The value is in pixels.


key: pathprefix

description: Add any path root in front of the generated. Example: "/images/"


key: stylesheet

description: Define stylesheets (css, less, sass) to be generated as part of the sprite generation process.


description: Freifunk Community API 0.5.2

enum: AF AX AL DZ AS AD AO AI AQ AG AR AM AW AC AU AT AZ BS BH BD BB BY BE BZ BJ BM BT BO BA BW BV BR IO BN BG BF BI KH CM CA IC CV KY CF TD CL CN CX CC CO KM CG CD CK CR CI HR CU CY CZ DK DG DJ DM DO EC EG SV GQ ER EE ET EU FK FO FJ FI FR GF PF TF GA GM GE DE GH GI GR GL GD GP GU GT GG GN GW GY HT HM VA HN HK HU IS IN ID IR IQ IE IM IL IT JM JP JE JO KZ KE KI KP KR KW KG LA LV LB LS LR LY LI LT LU MO MK MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN ME MS MA MZ MM NA NR NP NL AN NC NZ NI NE NG NU NF MP NO OM PK PW PS PA PG PY PE PH PN PL PT PR QA RE RO RU RW SH KN LC PM VC WS SM ST SA NT SN CS SC SL SG SK SI SB SO ZA GS SU ES LK SD SR SJ SZ SE CH SY TW TJ TZ TH TL TG TK TO TT TA TN TR TM TC TV UG UA AE GB US UY UZ VU VE VN VG VI WF EH YE ZM ZW

required: lat lon

format: email

required: city geoCode

format: date

enum: blog forum ics podcast wiki others

format: date-time

enum:
infrastructure/backbone
Public Free Wifi
Social Community Building
Local services and content
Free internet access

enum: ffmap ffsomething olsr-dot openwifimap netmon libremap nodewatcher kml nodelist meshviewer hopglass

enum: geographical structural list/status

enum: betterplace boost

enum: automatic fwimage mail webform else

enum: nothing vpnnational vpninternational zappscript p2pblock splashpage termsconditions anonymizer institutions

required: name location contact url state techDetails


key: city

description: Name of the city


key: country

description: Your country, list has been taken from http://countrylist.net/de/


key: address

description: The address of the place you meet


key: name

description: The name of the place you meet


key: street

description: The street address of your meeting place


key: zipcode

description: The zip code of your meeting place


key: lat

description: Lattitude of your city in decimal degrees


key: lon

description: Longitude of your city in decimal degrees


key: api

description: The Freifunk Community API version you use


description: The name of your community


key: metacommunity

description: The name of your metacommunity, if your local community belongs to a bigger one


key: location

description: Position data such as a postal address or geographic coordinates


key: additionalLocations

description: Add some more locations where your community is active.


key: email

description: Email address to which other people can contact your community (user@domain.com)


key: facebook

description: URL to your community's facebook account (https://facebook.com/...)


key: identica

description: URL to your community's identica account (https://identi.ca/...)


key: irc

description: Your community's ICR channel; starts with irc://


key: jabber

description: A jabber account someone reads (account@jabberserver.tld)


key: ml

description: The email address (user@domain.com) of your mailing list or a link to the mailinglist info page (http{s}://...)


key: googleplus

description: URL to your community's g+ account (https://plus.google.com/...)


key: matrix

description: URL to your community's matrix channel (https://matrix.to/#/!...)


key: mastodon

description: URL to your community's mastodon profile (https://...)


key: twitter

description: Your community's Twitter name (starts with @)


key: webform

description: URL to your community's contact form (http{s}://...)


key: phone

description: If your community has a phone number (e.g. +49 1234 567890 based on the E.123 notation)


key: url

description: The main website (http{s}://...)


key: timeline

description: These are lifetime events something like date of birth (and rebirth :-) of your community or other important milestones


key: description

description: Description of your lifetime event


key: timestamp

description: ISO 8601 timestamp of the event's date (format yyyy-mm-dd)


description: URL to details of this timeline-element


key: feeds

description: Feeds you provide your community


key: name

description: Name of the feed


key: category

description: Category of the feed like blog entries, calendars, forum messages, wiki articles, ...


key: type

description: Type of the feed like RSS, Atom, XML


description: URL of the feed


key: state

description: A collection of status-related data. Actual open/closed status, icons, last change timestamp etc.


key: nodes

description: Number of active nodes. This field is predestined to be updated regularly, please see sample solutions for Gluon or OLSR


key: lastchange

description: At what ISO 8601 timestamp has your community status lastly changed?


key: message

description: A free-form string something like 'open for public', 'members only' or whatever you want it to be)


description: Describe your community in a few lines


key: focus

description: What's the focus of your local community?


key: nodeMaps

description: Maps of nodes or topology your community provides


description: The URL where the map is located


key: interval

description: How often the map will be refreshed


key: technicalType

description: The kind of map is used


key: mapType


key: services

description: Services Provided by your community


key: serviceName

description: Name of your service (e.g. jabber...)


key: serviceDescription

description: Describe your service


key: externalUri

description: URI to use your service from the internet


key: internalUri

description: URI to use your service from Freifunk or icvpn-networks


key: name

description: Name of the Club


key: street

description: Address - Street


key: zip

description: Address - ZIP


key: url

description: The club's website (http{s}://...)


key: email

description: Email address to contact the club (user@domain.com)


key: board

description: Who are the board members of the club?


key: usage

description: Please use this string as transfer-purpose to define a special usage of your donation.


key: provider

description: Where do you host your donations?


key: projectid

description: ID of your project, Betterplace-IDs are multiple digits and can be found within the URL


key: number

description: Number of projects supported by your Community


key: website

description: A link to a web site where people can find an overview over your projects


key: contact

description: Please provide an email address to contact you on refugees and social projects


key: policyurl

description: URL to your privacy policy description


key: techDetails

description: Technical details of your community's Freifunk implementation

enum: none manual autoupdate


description: Link to your firmware images


key: docs

description: Link to your firmware docs


key: vpnaccess

description: How to access your VPN services


key: registrationurl

description: link to your website to request a new VPN key


key: orgrestrictions

description: Are there any organizational restrictions when using/installing your firmware?


key: techrestrictions

description: Are there any technical restrictions like hardware?


key: name

description: Name of your firmware


key: dns

description: DNS servers for domains used by your community


key: domainname

description: The domain name (e.g. ffhh, ffol)


key: nameserver

description: Nameservers servings zones of your domain


key: networks

description: Networks used by your community


description: IPv6 networks used by your community


key: network

description: IPv6 network network (e.g.2620:0:2d0:200::7/32) in CIDR notation


description: IPv4 networks used by your community


description: IPv4 network name (e.g. 10.w.x.y/z) in CIDR notation


key: routing

description: Routing protocols used within your community


key: legals

description: What do you use to handle legal issues, e.g. the German Störerhaftung or restrictions in your country?


key: updatemode

description: How do you deploy firmware updates?


key: RuleType

description: An enumeration.

enum: refactoring suggestion comment hover


key: disable

description: A list of rule IDs Sourcery will never suggest.


description: A string specifying the lowest Python version your project supports. Sourcery will not suggest refactorings requiring a higher Python version.


key: RuleLanguage

description: An enumeration.

enum: python java javascript typescript


key: version

description: The schema version of this config file


key: ignore

description: A list of paths or files which Sourcery will ignore.


key: rules

description: A list of custom rules Sourcery will include in its analysis.


description: Additional rule tags.


description: An API describes an interface that can be exposed by a component. The API can be defined in different formats, like OpenAPI, AsyncAPI, GraphQL, gRPC, or other formats.

kind: API

artist-api

product_name: Random value Generator

type: openapi

lifecycle: production

owner: artist-relations-team

[System] artist-engagement-portal

required: type lifecycle owner definition

examples: openapi asyncapi graphql grpc

examples: experimental production deprecated


key: metadata

description: Retrieve artist details


key: type

description: The type of the API definition.


key: lifecycle

description: The lifecycle state of the API.


key: owner

description: An entity reference to the owner of the API.


key: system

description: An entity reference to the system that the API belongs to.


key: definition

description: The definition of the API, based on the format defined by the type.


key: $text

description: Interprets the contents of the referenced file as plain text and embeds it as a string.


key: $json

description: Interprets the contents of the referenced file as JSON and embeds the parsed structure.


key: $yaml

description: Interprets the contents of the referenced file as YAML and embeds the parsed structure.


description: A Component describes a software component. It is typically intimately linked to the source code that constitutes the component, and should be what a developer may regard a "unit of software", usually with a distinct deployable or linkable artifact.

kind: Component

type: service

owner: tools

required: type lifecycle owner

examples: service website library


description: Creates Lorems like a pro.


description: The type of component.


description: The lifecycle state of the component.


description: An entity reference to the owner of the component.


description: An entity reference to the system that the component belongs to.


key: subcomponentOf

description: An entity reference to another component of which the component is a part.


key: providesApis

description: An array of entity references to the APIs that are provided by the component.


key: consumesApis

description: An array of entity references to the APIs that are consumed by the component.


key: dependsOn

description: An array of references to other entities that the component depends on to function.


description: A Domain groups a collection of systems that share terminology, domain models, business purpose, or documentation, i.e. form a bounded context.

kind: Domain


description: Everything about artists


description: A group describes an organizational entity, such as for example a team, a business unit, or a loose collection of people in an interest group. Members of these groups are modeled in the catalog as kind User.

kind: Group

type: business-unit

displayName: Infrastructure

parent: ops

children: backstage other

required: type children

examples: team business-unit product-area root

examples: backstage other


description: The infra business unit


description: The type of group. There is currently no enforced set of values for this field, so it is left up to the adopting organization to choose a nomenclature that matches their org hierarchy.


key: profile

description: Optional profile information about the group, mainly for display purposes. All fields of this structure are also optional. The email would be a group email of some form, that the group may wish to be used for contacting them. The picture is expected to be a URL pointing to an image that's representative of the group, and that a browser could fetch and render on a group page or similar.


key: displayName

description: A simple display name to present to users.


key: email

description: An email where this entity can be reached.


key: picture

description: The URL of an image that represents this entity.