OpenTAP 9.34
API Reference
OpenTap.Package.PackageCreateAction Class Reference

CLI sub command tap sdk create that can create a *.TapPackage from a definition in a package.xml file. More...

Inheritance diagram for OpenTap.Package.PackageCreateAction:
OpenTap.Package.PackageAction OpenTap.Cli.ICliAction OpenTap.ITapPlugin

Public Member Functions

 PackageCreateAction ()
 Constructs new action with default values for arguments.
 
override int Execute (CancellationToken cancellationToken)
 Executes this action.
 
- Public Member Functions inherited from OpenTap.Package.PackageAction
delegate void ProgressUpdateDelegate (int progressPercent, string message)
 A delegate used by ProgressUpdate
 
delegate void ErrorDelegate (Exception ex)
 A delegate type used by the Error event.
 
int Execute (CancellationToken cancellationToken)
 The code to be executed by the action.
 
- Public Member Functions inherited from OpenTap.Cli.ICliAction

Static Public Member Functions

static string GetRealFilePath (string path, string version, string extension)
 Obsolete. Do not use.
 

Static Public Attributes

static string DefaultEnding = "TapPackage"
 The default file extension for OpenTAP packages.
 
static string DefaultFileName = "Package"
 The default file name for the created OpenTAP package. Not used anymore, a default file name is now generated from the package name and version.
 

Properties

string PackageXmlFile [get, set]
 Represents an unnamed command line argument which specifies the package.xml file that defines the package that should be generated.
 
string ProjectDir [get, set]
 Represents the –project-directory command line argument, which specifies the directory containing the git repository used to get values for version/branch macros.
 
bool Install = false [get, set]
 Represents the –install command line argument. When true, this action will also install the created package.
 
bool FakeInstall = false [get, set]
 Obsolete, use Install property instead.
 
string[] OutputPaths [get, set]
 Represents the –out command line argument which specifies the path to the output file.
 

Additional Inherited Members

- Protected Member Functions inherited from OpenTap.Package.PackageAction
void RaiseError (Exception ex)
 Call this to raise the Error event.
 
void RaiseProgressUpdate (int progressPercent, string message)
 Call this to raise the ProgressUpdate event.
 
- Static Protected Attributes inherited from OpenTap.Package.PackageAction
static TraceSource log = OpenTap.Log.CreateSource("PackageAction")
 Log source for PackageAction plugins.
 
- Events inherited from OpenTap.Package.PackageAction
ProgressUpdateDelegate ProgressUpdate
 Called by the action to indicate how far it has gotten. Will usually be called with a progressPercent of 100 to indicate that it is done.
 
ErrorDelegate Error
 Called when a critical error happens.
 

Detailed Description

CLI sub command tap sdk create that can create a *.TapPackage from a definition in a package.xml file.

OpenTAP 9.34 API built Wed Jul 1 2026 09:21:16