Skip to content

Commit 3504fda

Browse files
committed
Add RepositoryConfig doc comments
1 parent 5ed161d commit 3504fda

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/config.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,24 @@ pub const CONFIG_FILE_PATH: &str = "rust-bors.toml";
1212
/// file located in the root of the repository file tree.
1313
#[derive(serde::Deserialize, Debug)]
1414
pub struct RepositoryConfig {
15+
/// Maximum duration (in seconds) to wait for CI checks to complete before timing out.
16+
/// Defaults to 3600 seconds (1 hour).
1517
#[serde(
1618
default = "default_timeout",
1719
deserialize_with = "deserialize_duration_from_secs"
1820
)]
1921
pub timeout: Duration,
22+
/// Label modifications to apply when specific events occur.
23+
/// Maps trigger events (approve, try, etc.) to label additions/removals.
24+
/// Format: `trigger = ["+label_to_add", "-label_to_remove"]`
2025
#[serde(default, deserialize_with = "deserialize_labels")]
2126
pub labels: HashMap<LabelTrigger, Vec<LabelModification>>,
27+
/// Minimum time (in seconds) to wait for CI checks to complete before proceeding.
28+
/// Defaults to `None` (no minimum wait time).
2229
#[serde(default, deserialize_with = "deserialize_duration_from_secs_opt")]
2330
pub min_ci_time: Option<Duration>,
31+
/// Whether auto merging is enabled.
32+
/// Defaults to false.
2433
#[serde(default)]
2534
pub merge_queue_enabled: bool,
2635
}

0 commit comments

Comments
 (0)