shippy
Client-side tool to interface with shipper
Usage
Get shippy from PyPI:
pipx install shipper-shippy # pipx, recommended
pip3 install --upgrade shipper-shippy # or pip3
Go to the directory with build files, and run:
shippy
Run shippy -h
to see commandline arguments' usage instructions.
Configuration
shippy stores its configuration in ~/.shippy.ini
. An example configuration file is shown below:
[shippy]
server = https://example.com
token = a1b2c3d4e5...
DisableBuildOnUpload = false
UploadWithoutPrompt = false
debug = false
Configuration options explained:
server
Server URL
token
Token used to sign in to the server
DisableBuildOnUpload
Immediately disables the build after uploading it. Useful if you are uploading from Jenkins or uploading potentially
unstable builds. Do NOT use under normal circumstances!
UploadWithoutPrompt
shippy will not prompt you before uploading builds, and will automatically upload all builds found in the current
directory. Use with caution. Same as the -y
/--yes
flag shown above.
debug
Enable debug mode for all invocations. When set to true, the -d
/--debug
flag will have no effect, and all
invocations of shippy will run with debug mode enabled.
Status
shippy returns exit codes based on the results.
1
- Ctrl-C exit
2
- one or more builds failed to upload and/or set disabled status