Skip to content
This repository was archived by the owner on Oct 28, 2024. It is now read-only.

Commit 528fc11

Browse files
authored
Publish 0.4.0 (#24)
1 parent d5ccbc1 commit 528fc11

File tree

3 files changed

+19
-8
lines changed

3 files changed

+19
-8
lines changed

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "hippofactory"
3-
version = "0.3.0"
3+
version = "0.4.0"
44
authors = ["Ivan Towlson <itowlson@microsoft.com>"]
55
edition = "2018"
66

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -190,22 +190,33 @@ or `signature` features. It does not yet support push options other than the se
190190
## Running hippofactory
191191

192192
As a developer you can run `hippofactory .` in your `HIPPOFACTS` directory to assemble all matching
193-
files and push them to the Bindle server specified in the `BINDLE_SERVER_URL` environment variable.
194-
(If you don't want to set the environment variable, pass the `-s` argument with the URL.)
195-
196-
In this mode, `hippofactory`:
193+
files and publish them as a bindle. In this mode, `hippofactory`:
197194

198195
* Mangles the version with a prerelease segment
199196
* Stages to a temporary directory
200197
* Pushes to the Bindle server
198+
* Notifies Hippo that a new bindle version is available
199+
200+
The Bindle server is specified in the `BINDLE_SERVER_URL` environment variable.
201+
(If you don't want to set the environment variable, pass the `-s` argument with the URL.)
201202

202-
If you want to review the proposed bindle rather than pushing it, pass `--prepare -d <staging_dir>`.
203+
The Hippo URL is specified in the `HIPPO_SERVICE_URL` environment variable. Hippo
204+
requires authentication: pass the username in `HIPPO_USERNAME` and the password in
205+
`HIPPO_PASSWORD`. (The equivalent command line options are `--hippo-url`, `--hippo-username`
206+
and `--hippo-password`.)
207+
208+
If you want to review the proposed bindle rather than pushing it, pass `--action prepare -d <staging_dir>`.
203209
This will stage the bindle to the specified directory but _not_ push it. (If you later want
204-
to push it, you can do so using the separate `bindle` tool.)
210+
to push it, you can do so using the separate `bindle` tool.) If you want to push the generated
211+
bindle but not notify Hippo, pass `--action bindle`.
205212

206213
In a CI environment you can supply the `-v production` option to suppress version mangling.
207214
This will create and upload the bindle with the version from `HIPPOFACTS`, without the
208215
prerelease segment.
216+
217+
If you want to skip server verification, pass the `-k` flag. This can be useful if you are running
218+
development services with self-signed certificates. **This is a security risk: do not use it in production.**
219+
209220
## Building from source
210221

211222
* Known link failure on WSL: workaround is to build once with `RUSTFLAGS='-C opt-level=0' cargo build`

0 commit comments

Comments
 (0)