serokell/deploy-rs
1
1
Fork 0
mirror of https://github.com/serokell/deploy-rs.git synced 2024-09-11 02:35:39 +03:00
Code Issues Projects Releases Wiki Activity

[Chore] Add missing documentation for timeout options

Browse Source 
Problem: README misses documentation for 'confirmTimeout' and
'activationTimeout'.

Solution: Mention them in README.
This commit is contained in:
Roman Melnikov 2023-12-20 13:54:27 +01:00
parent 915327515f
commit 56ba8c3929
No known key found for this signature in database
GPG Key ID: 8931E8ED1EE2E537
2 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -218,9 +218,19 @@ This is a set of options that can be put in any of the above definitions, with t
# Will also fetch all external dependencies from the target system's substituters.
# This default to `false`
remoteBuild = true;
# Timeout for profile activation.
# This defaults to 240 seconds.
activationTimeout = 600;
# Timeout for profile activation confirmation.
# This defaults to 30 seconds.
confirmTimeout = 60;
}
```
Some of these options can be provided during `deploy` invocation to override default values or values provided in your flake, see `deploy --help`.
## About Serokell
deploy-rs is maintained and funded with ❤️ by [Serokell](https://serokell.io/).

2
src/cli.rs
View File

@ -85,7 +85,7 @@ pub struct Opts {
/// How long activation should wait for confirmation (if using magic-rollback)
#[clap(long)]
confirm_timeout: Option<u16>,
/// How long we should wait for profile activation (if using magic-rollback)
/// How long we should wait for profile activation
#[clap(long)]
activation_timeout: Option<u16>,
/// Where to store temporary files (only used by magic-rollback)