< Back
Publish-BMReleasePackage
Post
NAME Publish-BMReleasePackage
SYNOPSIS
Deploys a release package in BuildMaster.
SYNTAX
Publish-BMReleasePackage [-Session] <Object> [-Package] <Object> [[-Stage] <String>] [-Force] [<CommonParameters>]
DESCRIPTION
The `Publish-BMReleasePackage` deploys a release package in BuildMaster. The package is deployed using the
pipeline assigned to the release the package is part of. This function uses BuildMaster's [Release and Package
Deployment API](http://inedo.com/support/documentation/ ... nd-package).
Pass the package to deploy to the `Package` parameter. This can be a package object or a package ID (as an
integer).
To deploy a package, it must be part of a release that has a pipeline. That pipeline must have at least one stage
and that stage must have a plan. If none of these conditions are met, you'll get no object back with no errors
written.
PARAMETERS
-Session <Object>
An object representing the BuildMaster instance to connect to. Use the `New-BMSession` function to create a
session object.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Package <Object>
The package to deploy. Can be:
* A package object which has an `id` property.
* The package's ID, as an integer.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Stage <String>
The name of the pipeline stage where the package will be deployed.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
Instructs BuildMaster to run the deploy even if the deploy to previous stages failed.
Required? false
Position? named
Default value False
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:\\>Publish-BMReleasePackage -Session $session -Package $package
Demonstrates how to deploy a package by passing a package object to the `Package` parameter. This object must have
an `id` or `pipeline_id` property.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Publish-BMReleasePackage -Session $session -Package 383
Demonstrates how to deploy a package by passing its ID to the `Package` parameter.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Publish-BMReleasePackage -Session $session -Package $package -Stage $stage
Demonstrates how to deploy a package to a specific stage of the release pipeline. By default, a package will
deploy to the first stage of the assigned pipeline.
RELATED LINKS
SYNOPSIS
Deploys a release package in BuildMaster.
SYNTAX
Publish-BMReleasePackage [-Session] <Object> [-Package] <Object> [[-Stage] <String>] [-Force] [<CommonParameters>]
DESCRIPTION
The `Publish-BMReleasePackage` deploys a release package in BuildMaster. The package is deployed using the
pipeline assigned to the release the package is part of. This function uses BuildMaster's [Release and Package
Deployment API](http://inedo.com/support/documentation/ ... nd-package).
Pass the package to deploy to the `Package` parameter. This can be a package object or a package ID (as an
integer).
To deploy a package, it must be part of a release that has a pipeline. That pipeline must have at least one stage
and that stage must have a plan. If none of these conditions are met, you'll get no object back with no errors
written.
PARAMETERS
-Session <Object>
An object representing the BuildMaster instance to connect to. Use the `New-BMSession` function to create a
session object.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Package <Object>
The package to deploy. Can be:
* A package object which has an `id` property.
* The package's ID, as an integer.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Stage <String>
The name of the pipeline stage where the package will be deployed.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
Instructs BuildMaster to run the deploy even if the deploy to previous stages failed.
Required? false
Position? named
Default value False
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:\\>Publish-BMReleasePackage -Session $session -Package $package
Demonstrates how to deploy a package by passing a package object to the `Package` parameter. This object must have
an `id` or `pipeline_id` property.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Publish-BMReleasePackage -Session $session -Package 383
Demonstrates how to deploy a package by passing its ID to the `Package` parameter.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Publish-BMReleasePackage -Session $session -Package $package -Stage $stage
Demonstrates how to deploy a package to a specific stage of the release pipeline. By default, a package will
deploy to the first stage of the assigned pipeline.
RELATED LINKS