| Line 1: |
| |
|
+ |
This page lists how to use the pre-flight tool for AnthillPro.
|
| |
|
+ |
<pre>Usage: preflight <option>
|
| |
|
+ |
preflight <command> <options>
|
| |
|
|
|
| |
|
+ |
<no-command>
|
| |
|
+ |
--help show help
|
| |
|
+ |
--version show version
|
| |
|
|
|
| |
|
+ |
<any-command>
|
| |
|
+ |
-v, --verbose show additional output
|
| |
|
+ |
--debug show debug output
|
| |
|
|
|
| |
|
+ |
config - configure user option
|
| |
|
+ |
user <user> configure anthill user
|
| |
|
+ |
password [<password>] configure anthill password
|
| |
|
+ |
url <url> configure anthill url
|
| |
|
+ |
cert-trusted <boolean> configure anthill certificate trust
|
| |
|
+ |
local-server-host <host> configure file server host
|
| |
|
+ |
local-server-port <port> configure file server bind port
|
| |
|
|
|
| |
|
+ |
build - build a project
|
| |
|
+ |
-p, --project <name|id> target project (required)
|
| |
|
+ |
-w, --workflow <name|id> target workflow (required)
|
| |
|
+ |
-i, --include <path> include path in source
|
| |
|
+ |
-x, --exclude <path> exclude path from source
|
| |
|
+ |
-I, --include-artifact <path> include path in delivered artifacts
|
| |
|
+ |
-X, --exclude-artifact <path> exclude path from delivered artifacts
|
| |
|
+ |
-D, --property <name>=<value> set workflow property value
|
| |
|
+ |
--dir <path> override working directory
|
| |
|
+ |
-O, --output <path> override output directory
|
| |
|
+ |
-l, --log <path> set preflight log file
|
| |
|
+ |
--url <url> override configured anthill url
|
| |
|
+ |
--user <username> override configured anthill user
|
| |
|
+ |
--password [<password>] override configured anthill password
|
| |
|
+ |
--local-server-host <host> set file server host
|
| |
|
+ |
--local-server-port <port> set file server port</pre>
|
| |
|
|
|
| |
|
+ |
= Explanation =
|
| |
|
|
|
| |
|
+ |
The '''preflight client''' first starts a simple file server. The server is used to
|
| |
|
+ |
transfer source files from the user desktop to a build agent and to transfer
|
| |
|
+ |
build artifacts from the build agent to the user desktop. Next, the preflight
|
| |
|
+ |
client requests anthill to perform a build. It is expected that the build will
|
| |
|
+ |
have special preflight transfer steps already configured. One step will request
|
| |
|
+ |
source files from the preflight client that originated the build and lay them
|
| |
|
+ |
down in the workspace directory. The second step will send artifacts from the
|
| |
|
+ |
agent back to the preflight client.
|
| |
|
|
|
| |
|
+ |
The basic model for a preflight workflow is this.
|
| |
|
|
|
| |
|
+ |
# Check out source.
|
| |
|
+ |
# Transfer modified source files from the preflight client. These files will overwrite the pristine copy.
|
| |
|
+ |
# Run build commands.
|
| |
|
+ |
# Transfer build artifacts to the preflight client.
|
| |
|
|
|
| |
|
+ |
Alternatively, the source checkout step could be skipped altogether and the
|
| |
|
+ |
preflight client will provide all source files.
|
| |
|
|
|
| |
|
+ |
= Installation =
|
