This repository has been archived by the owner on Sep 3, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ff92433
commit 28bcb07
Showing
1 changed file
with
1 addition
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,53 +1,3 @@ | ||
# shippy | ||
![version](https://img.shields.io/github/v/release/ericswpark/shippy) | ||
![commits-since](https://img.shields.io/github/commits-since/ericswpark/shippy/latest) | ||
[ | ||
![PyPI](https://img.shields.io/pypi/v/shipper-shippy) | ||
![PyPI - Downloads](https://img.shields.io/pypi/dm/shipper-shippy) | ||
](https://pypi.org/project/shipper-shippy/) | ||
|
||
Client-side tool to interface with shipper | ||
|
||
# Usage | ||
|
||
Get shippy from PyPI: | ||
|
||
```shell | ||
pip3 install --upgrade shipper-shippy | ||
``` | ||
|
||
Go to the directory with build files, and run: | ||
|
||
```shell | ||
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: | ||
|
||
```ini | ||
[shippy] | ||
server = https://example.com | ||
token = a1b2c3d4e5... | ||
DisableBuildOnUpload = false | ||
UploadWithoutPrompt = 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. | ||
This repository has been deprecated in favor of the monorepo `shipper`! |