Connect-AppVeyorToDocker

NAME Connect-AppVeyorToDocker



SYNOPSIS

Command to enable Docker builds. Works with both hosted AppVeyor and AppVeyor Server.





SYNTAX

Connect-AppVeyorToDocker [-AppVeyorUrl] <String> [-ApiToken] <String> [-ImageOs] <String> [-ImageName] <String>

[-ImageTemplate] <String> [[-ImageFeatures] <String>] [[-ImageCustomScript] <String>] [<CommonParameters>]





DESCRIPTION

You can connect your AppVeyor account (on both hosted AppVeyor and on-premise AppVeyor Server) to Docker for

AppVeyor to instantiate build containers on it.





PARAMETERS

-AppVeyorUrl <String>

AppVeyor URL. For hosted AppVeyor it is https://ci.appveyor.com. For Appveyor Server users it is URL of

on-premise AppVeyor Server installation



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ApiToken <String>

API key for specific account (not 'All accounts'). Hosted AppVeyor users can find it at

https://ci.appveyor.com/api-keys. Appveyor Server users can find it at <appveyor_server_url>/api-keys.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ImageOs <String>

Operating system of container image. Valid values: 'Windows', 'Linux'.



Required? true

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ImageName <String>

Description to be used for AppVeyor image.



Required? true

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ImageTemplate <String>

Docker image name.



Required? true

Position? 5

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ImageFeatures <String>

Optional comma-separated list of image products/tools/libraries that should be installed on top of the base

image.



Required? false

Position? 6

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ImageCustomScript <String>



Required? false

Position? 7

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Connect-AppVeyorToDocker



Let command collect all required information









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Connect-AppVeyorToDocker -ApiToken XXXXXXXXXXXXXXXXXXXXX -AppVeyorUrl "https://ci.appveyor.com" -ImageOs

Windows -ImageName Windows -ImageTemplate 'appveyor/build-image:minimal-nanoserver-1809'



Run command with all required parameters so command will ask no questions. It will pull Docker image and configure

Docker build cloud in AppVeyor.











RELATED LINKS