Expand description
§Configuration
Project-specific configuration for Shipper via .shipper.toml.
This crate loads, validates, and merges configuration from three layers (highest priority first):
- CLI flags — passed via
CliOverrides - Config file —
.shipper.tomlin the workspace root - Built-in defaults — sensible defaults for all settings
The central type is ShipperConfig, which maps 1:1 to the TOML file
and exposes ShipperConfig::build_runtime_options to produce the
final RuntimeOptions used by the engine.
§Sections
| TOML section | Rust type | Controls |
|---|---|---|
[policy] | PolicyConfig | Safety vs speed preset |
[verify] | VerifyConfig | Pre-publish compilation check |
[readiness] | ReadinessConfig | Post-publish visibility polling |
[output] | OutputConfig | Evidence capture line count |
[lock] | LockConfig | Distributed lock timeout |
[retry] | RetryConfig | Retry strategy and backoff |
[flags] | FlagsConfig | Git-dirty, ownership, etc. |
[parallel] | ParallelConfig | Concurrent publishing |
[registry] | RegistryConfig | Custom registry |
[registries] | MultiRegistryConfig | Multi-registry publishing |
[webhook] | WebhookConfig | Publish notifications |
[encryption] | EncryptionConfigInner | State file encryption |
[storage] | StorageConfigInner | Cloud storage backend |
Modules§
- runtime
- Runtime-options conversion helpers (previously
shipper-config-runtime). Conversion layer fromshipper_configmodel types to sharedshipper_types.
Structs§
- CliOverrides
- CLI flag overrides for merging with config file values.
- Encryption
Config - Encryption configuration
- Encryption
Config Inner - Nested encryption configuration
- Flags
Config - Nested flags configuration
- Lock
Config - Nested lock configuration
- Multi
Registry Config - Multiple registry configuration
- Output
Config - Nested output configuration
- Parallel
Config - Configuration for parallel publishing.
- Policy
Config - Nested policy configuration
- Readiness
Config - Configuration for readiness verification after publishing.
- Registry
- Represents a Cargo registry for publishing crates.
- Registry
Config - Registry configuration - supports both single registry and multiple registries
- Rehearsal
Config - Rehearsal registry configuration.
- Retry
Config - Nested retry configuration
- Runtime
Options - Runtime configuration options for a Shipper publish operation.
- Shipper
Config - Project-specific configuration loaded from
.shipper.toml. - Storage
Config Inner - Nested storage configuration for cloud storage backends
- Verify
Config - Nested verify configuration
- Webhook
Config - Webhook configuration
Enums§
- Publish
Policy - Policy presets that control the balance between safety and speed in publishing.
- Readiness
Method - Method for verifying crate visibility after publishing.
- Verify
Mode - Controls when and how
cargo verifyis run before publishing.
Functions§
- deserialize_
duration - Deserialize a
Durationfrom either a human-readable string or a millisecond integer. - serialize_
duration - Serialize a
Durationas milliseconds (u64) for stable round-tripping.