Set-DevartPackageInfo

Synopsis

Sets the properties to identify a package before exporting and/or publishing DatabaseProject.

Description

The cmdlet creates a build artifact from the validated project produced by the Invoke-DevartDatabaseBuild cmdlet.

Syntax

Set-DevartPackageInfo -Id <string> -Project <DatabaseProject> [-Description <string>] [-Documentation <string>] [-Version <string>] [<CommonParameters>]

Parameters

-Project

Generates the object of the Invoke-DevartDatabaseBuild or New-DevartDatabaseProject cmdlets returned by DatabaseProject.

-Project <DatabaseProject>
Property Default value
Required True
Position Named
Default value -
Accept pipeline input False
Accept wildcard characters False

-Id

Specifies a unique identifier for the package you want to create.

-Id <string>
Property Default value
Required True
Position Named
Default value -
Accept pipeline input False
Accept wildcard characters False

-Version

Specifies a version of the package. It must be in a valid NuGet version format, for example, 1.0.1-beta.

-Version <string>
Property Default value
Required False
Position Named
Default value 1.0.0
Accept pipeline input False
Accept wildcard characters False

-Description

Specifies a description of the package you want to create.

-Description <string>
Property Default value
Required False
Position Named
Default value Automatically generated by Devart dbForge DevOps Automation PowerShell for SQL Server
Accept pipeline input False
Accept wildcard characters False

-Documentation

Specifies a path to the documentation file or directory.

-Documentation <string>
Property Default value
Required False
Position Named
Default value -
Accept pipeline input False
Accept wildcard characters False

Common parameters

<CommonParameters>

This cmdlet supports these common parameters:

  • Verbose – Provides detailed output about the command operation.
  • Debug – Provides debugging information.
  • ErrorAction – Specifies how to respond to errors.
  • ErrorVariable – Stores error messages in a variable.
  • WarningAction – Specifies how to respond to warnings.
  • WarningVariable – Stores warning messages in a variable.
  • InformationAction – Specifies how informational messages are handled.
  • InformationVariable – Stores informational messages in a variable.
  • OutBuffer – Controls the number of objects buffered before output.
  • PipelineVariable – Stores the current pipeline object in a variable.
  • OutVariable – Stores output objects in a variable.

For more information, see About Common Parameters.

Output

System.Boolean (returns true on success and false otherwise)

System.Boolean returns:

  • true if the operation was successful.
  • false if the operation failed.

Example

Set-DevartPackageInfo -Project $databaseProject -Id Devart.DbForge.DevOpsAutomation.ScriptFolder -Version 1.0.1