Octo Pack Action

Octo Pack

Name

A friendly name for this action (will be displayed in the actions workflow area).

Enabled

Determines if this action will be run within the relevant stage.

Package Id

The Id of the package. [---id]

Package Format

The format of the package. [---format]

Version

The version of the package. This must be in semantic version format. If left empty, it will default to a timestamp-based version. [---version]

Working Folder

The folder containing files and folders to pack. If left empty, it will default to the workspace folder.

Output Folder

Specify the directory for the generated package file. Relative to the working folder. [---outFolder]

Using

The Using drop down is populated with any property collector whose namespace matches the pattern defined by the Octo Pack action. The pattern for this action is ^Octo.*

If you create a property collector for this action, make sure you select the Path Finder PlugIn type and give it a name that will match the pattern above in blue. Example names listed here, search the table's Plugin column for "Octo Pack".

For more in-depth explanations on property collectors see Property Collectors.

Alternatively, you can select the Custom option from the Using drop down list and specify a path in the resulting input field that will be displayed. Please read Why it's a good idea to use a property collector before using this option.

Metadata

Author

Add an author to the package metadata. [---author]

Title

The title of the package. [---title]

Description

A description of the package. [---description]

Release Notes

Release notes for this version of the package. [---releaseNotes]

Release Notes File

Path to a file containing release notes for this version of the package. [---releaseNotesFile]

Options

Include Paths

Add a file pattern to include, relative to the base path. If left empty, defaults to all files e.g. **. [---include]

Overwrite

If this ticked, existing package files with the same Id/version will be overwritten. [---overwrite]

Verbose

Verbose output. [--verbose]

Timeout (in seconds)

How long to wait for the action to finish running before timing out. Leaving this blank (or zero) will default to 86400 seconds (24 hours).

Treat failure as warning

Tick to continue build on failure marking the action with a warning status.

Ignore warnings

If this is ticked, any warnings logged will not mark the action with a warning status.

Environment

Environment Variables

Multiple environment variables can be defined - one per line. These are set before the command line is run.

Log environment variables

If this is ticked, environment variable values are written to the build log.

Generate system environment variables

Tick this checkbox to set up a list of new environment variables prefixed with 'ContinuaCI.' for all current system expression objects and variables.

Mask sensitive variable values in system environment variables

This checkbox is visible only if the 'Generate system environment variables' checkbox is ticked.

If this is ticked, the values of any variables marked as sensitive will be masked with **** when setting system environment variables. Clear this to expose the values.