shipper 0.4.0

Reliable, resumable `cargo publish` for Rust workspaces. The install facade for the `shipper` CLI.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

# shipper

Installable release-execution facade for Rust workspaces.

A workspace release can fail after some crates publish and before the rest do. Cargo's own docs note that `cargo publish --workspace` is non-atomic and that a client timeout does not always mean the upload failed. Shipper gives you a plan, a preflight gate, durable state, and a recovery path for that failure mode.

## Install

The stable 0.4.0 install package is `shipper`:

```bash
cargo install shipper --locked
```

For reproducible 0.4.0 installs, pin the version:

```bash
cargo install shipper --version 0.4.0 --locked
```

This becomes the supported crates.io path after the `v0.4.0` publish completes.

From a checkout, validate the same install facade with:

```bash
cargo install --path crates/shipper --locked
```

## Quick start

```bash
shipper plan        # preview the publish order
shipper preflight   # check readiness
shipper publish     # execute the plan
shipper resume      # continue after an interrupted run
```

`shipper --help` and `shipper <subcommand> --help` are the canonical command reference.

## What this crate is

`shipper` is the user-facing package — the one you install and the one that shows up on crates.io. It wraps:

- a small binary that forwards to the CLI adapter,
- a curated library re-export over the engine (`engine`, `plan`, `types`, `config`, `state`, `store`),
- product-facing documentation.

The actual work happens in two sibling crates:

- [`shipper-cli`](https://crates.io/crates/shipper-cli) — CLI adapter (clap parsing, subcommands, output, `pub fn run()`).
- [`shipper-core`](https://crates.io/crates/shipper-core) — engine library with no CLI dependencies.

## Use another crate when

- You want the lean embedding surface (no `clap`, no `indicatif`) → depend on [`shipper-core`](https://crates.io/crates/shipper-core).
- You need the exact clap-driven CLI surface programmatically (custom wrappers, pre-run hooks) → depend on [`shipper-cli`](https://crates.io/crates/shipper-cli) and call `shipper_cli::run()`.
- You want `shipper` as a library but without the `clap` graph → `shipper = { version = "...", default-features = false }`.

## Scope

Shipper handles publishing, retrying, resuming, rehearsing, yanking, and fix-forward planning. It does not decide version numbers, generate changelogs, tag releases, or create GitHub releases — pair it with your preferred versioning/release workflow.

## Documentation

- Project README: <https://github.com/EffortlessMetrics/shipper#readme>
- Full docs tree: <https://github.com/EffortlessMetrics/shipper/tree/main/docs>
- Configuration reference: <https://github.com/EffortlessMetrics/shipper/blob/main/docs/configuration.md>

## Stability

Pre-1.0. Breaking changes are called out in [`CHANGELOG.md`](https://github.com/EffortlessMetrics/shipper/blob/main/CHANGELOG.md).

## License

MIT OR Apache-2.0.