Skip to content

use BTreeSet for ruleset rules #2319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marcoieni merged 1 commit into from
Mar 13, 2026
Merged

use BTreeSet for ruleset rules #2319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions src/sync/github/api/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ use reqwest::{
};
use secrecy::ExposeSecret;
use serde::{Deserialize, de::DeserializeOwned};
use std::collections::BTreeSet;
use std::fmt;
use thiserror::Error;
use tokens::GitHubTokens;
Expand Down Expand Up @@ -529,24 +530,24 @@ pub(crate) struct Ruleset {
#[serde(skip_serializing_if = "Option::is_none")]
pub(crate) bypass_actors: Option<Vec<RulesetBypassActor>>,
pub(crate) conditions: RulesetConditions,
pub(crate) rules: Vec<RulesetRule>,
pub(crate) rules: BTreeSet<RulesetRule>,
}

#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "lowercase")]
pub(crate) enum RulesetTarget {
Branch,
Tag,
}

#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "PascalCase")]
pub(crate) enum RulesetSourceType {
Repository,
Organization,
}

#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "lowercase")]
pub(crate) enum RulesetEnforcement {
Active,
Expand Down Expand Up @@ -588,7 +589,7 @@ pub(crate) struct RulesetRefNameCondition {
pub(crate) exclude: Vec<String>,
}

#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, serde::Serialize, serde::Deserialize)]
#[serde(tag = "type", rename_all = "snake_case")]
pub(crate) enum RulesetRule {
Creation,
Expand All @@ -611,7 +612,7 @@ pub(crate) enum RulesetRule {
NonFastForward,
}

#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, serde::Serialize, serde::Deserialize)]
pub(crate) struct MergeQueueParameters {
pub(crate) check_response_timeout_minutes: i32,
pub(crate) grouping_strategy: MergeQueueGroupingStrategy,
Expand All @@ -622,27 +623,27 @@ pub(crate) struct MergeQueueParameters {
pub(crate) min_entries_to_merge_wait_minutes: i32,
}

#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
pub(crate) enum MergeQueueGroupingStrategy {
Allgreen,
Headgreen,
}

#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
pub(crate) enum MergeQueueMergeMethod {
Merge,
Squash,
Rebase,
}

#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, serde::Serialize, serde::Deserialize)]
pub(crate) struct RequiredDeploymentsParameters {
pub(crate) required_deployment_environments: Vec<String>,
}

#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, serde::Serialize, serde::Deserialize)]
pub(crate) struct PullRequestParameters {
pub(crate) dismiss_stale_reviews_on_push: bool,
pub(crate) require_code_owner_review: bool,
Expand All @@ -651,15 +652,15 @@ pub(crate) struct PullRequestParameters {
pub(crate) required_review_thread_resolution: bool,
}

#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, serde::Serialize, serde::Deserialize)]
pub(crate) struct RequiredStatusChecksParameters {
#[serde(skip_serializing_if = "Option::is_none")]
pub(crate) do_not_enforce_on_create: Option<bool>,
pub(crate) required_status_checks: Vec<RequiredStatusCheck>,
pub(crate) strict_required_status_checks_policy: bool,
}

#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, serde::Serialize, serde::Deserialize)]
pub(crate) struct RequiredStatusCheck {
pub(crate) context: String,
#[serde(skip_serializing_if = "Option::is_none")]
Expand Down
16 changes: 9 additions & 7 deletions src/sync/github/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -967,29 +967,31 @@ pub fn construct_ruleset(branch_protection: &rust_team_data::v1::BranchProtectio

let branch_protection_mode = get_branch_protection_mode(branch_protection);

let mut rules: Vec<RulesetRule> = Vec::new();
// Use a BTreeSet to ensure a consistent order. This avoids unnecessary diffs when the order of rules changes,
// since GitHub does not guarantee any specific order for rules.
let mut rules: BTreeSet<RulesetRule> = BTreeSet::new();

// Add creation protection if requested
if branch_protection.prevent_creation {
rules.push(RulesetRule::Creation);
rules.insert(RulesetRule::Creation);
}

// Add deletion protection if requested
if branch_protection.prevent_deletion {
rules.push(RulesetRule::Deletion);
rules.insert(RulesetRule::Deletion);
}

// Add non-fast-forward protection if requested
if branch_protection.prevent_force_push {
rules.push(RulesetRule::NonFastForward);
rules.insert(RulesetRule::NonFastForward);
}

// Add pull request rule if PRs are required
if let BranchProtectionMode::PrRequired {
required_approvals, ..
} = &branch_protection_mode
{
rules.push(RulesetRule::PullRequest {
rules.insert(RulesetRule::PullRequest {
parameters: PullRequestParameters {
dismiss_stale_reviews_on_push: branch_protection.dismiss_stale_review,
require_code_owner_review: false,
Expand All @@ -1006,7 +1008,7 @@ pub fn construct_ruleset(branch_protection: &rust_team_data::v1::BranchProtectio
{
let mut checks = ci_checks.clone();
checks.sort();
rules.push(RulesetRule::RequiredStatusChecks {
rules.insert(RulesetRule::RequiredStatusChecks {
parameters: RequiredStatusChecksParameters {
do_not_enforce_on_create: Some(false),
required_status_checks: checks
Expand All @@ -1023,7 +1025,7 @@ pub fn construct_ruleset(branch_protection: &rust_team_data::v1::BranchProtectio

if branch_protection.merge_queue {
// Enable merge queue with default settings
rules.push(RulesetRule::MergeQueue {
rules.insert(RulesetRule::MergeQueue {
parameters: MergeQueueParameters {
check_response_timeout_minutes: 360,
grouping_strategy: MergeQueueGroupingStrategy::Allgreen,
Expand Down
Loading