compliance: Fix casing of GitHub in structs and traits (zed-industries#53935)

MrSubidubi · web-flow · commit 5611cc282d8a · 2026-04-15T01:56:27.000+02:00
Release Notes:

- N/A
diff --git a/tooling/compliance/src/checks.rs b/tooling/compliance/src/checks.rs
@@ -5,7 +5,7 @@ use itertools::Itertools as _;
 use crate::{
     git::{CommitDetails, CommitList},
     github::{
-        CommitAuthor, GitHubClient, GitHubUser, GithubLogin, PullRequestComment, PullRequestData,
+        CommitAuthor, GithubClient, GithubLogin, GithubUser, PullRequestComment, PullRequestData,
         PullRequestReview, Repository, ReviewState,
     },
     report::Report,
@@ -18,7 +18,7 @@ const ZED_ZIPPY_GROUP_APPROVAL: &str = "@zed-industries/approved";
 pub enum ReviewSuccess {
     ApprovingComment(Vec<PullRequestComment>),
     CoAuthored(Vec<CommitAuthor>),
-    ExternalMergedContribution { merged_by: GitHubUser },
+    ExternalMergedContribution { merged_by: GithubUser },
     PullRequestReviewed(Vec<PullRequestReview>),
 }
 
@@ -98,11 +98,11 @@ impl<E: Into<anyhow::Error>> From<E> for ReviewFailure {
 
 pub struct Reporter<'a> {
     commits: CommitList,
-    github_client: &'a GitHubClient,
+    github_client: &'a GithubClient,
 }
 
 impl<'a> Reporter<'a> {
-    pub fn new(commits: CommitList, github_client: &'a GitHubClient) -> Self {
+    pub fn new(commits: CommitList, github_client: &'a GithubClient) -> Self {
         Self {
             commits,
             github_client,
@@ -331,13 +331,13 @@ mod tests {
 
     use crate::git::{CommitDetails, CommitList, CommitSha};
     use crate::github::{
-        AuthorsForCommits, GitHubApiClient, GitHubClient, GitHubUser, GithubLogin,
+        AuthorsForCommits, GithubApiClient, GithubClient, GithubLogin, GithubUser,
         PullRequestComment, PullRequestData, PullRequestReview, Repository, ReviewState,
     };
 
     use super::{Reporter, ReviewFailure, ReviewSuccess};
 
-    struct MockGitHubApi {
+    struct MockGithubApi {
         pull_request: PullRequestData,
         reviews: Vec<PullRequestReview>,
         comments: Vec<PullRequestComment>,
@@ -346,7 +346,7 @@ mod tests {
     }
 
     #[async_trait::async_trait(?Send)]
-    impl GitHubApiClient for MockGitHubApi {
+    impl GithubApiClient for MockGithubApi {
         async fn get_pull_request(
             &self,
             _repo: &Repository<'_>,
@@ -420,7 +420,7 @@ mod tests {
 
     fn review(login: &str, state: ReviewState) -> PullRequestReview {
         PullRequestReview {
-            user: Some(GitHubUser {
+            user: Some(GithubUser {
                 login: login.to_owned(),
             }),
             state: Some(state),
@@ -430,7 +430,7 @@ mod tests {
 
     fn comment(login: &str, body: &str) -> PullRequestComment {
         PullRequestComment {
-            user: GitHubUser {
+            user: GithubUser {
                 login: login.to_owned(),
             },
             body: Some(body.to_owned()),
@@ -451,7 +451,7 @@ mod tests {
             Self {
                 pull_request: PullRequestData {
                     number: 1234,
-                    user: Some(GitHubUser {
+                    user: Some(GithubUser {
                         login: "alice".to_owned(),
                     }),
                     merged_by: None,
@@ -497,14 +497,14 @@ mod tests {
         }
 
         async fn run_scenario(self) -> Result<ReviewSuccess, ReviewFailure> {
-            let mock = MockGitHubApi {
+            let mock = MockGithubApi {
                 pull_request: self.pull_request,
                 reviews: self.reviews,
                 comments: self.comments,
                 commit_authors_json: self.commit_authors_json,
                 org_members: self.org_members,
             };
-            let client = GitHubClient::new(Rc::new(mock));
+            let client = GithubClient::new(Rc::new(mock));
             let reporter = Reporter::new(CommitList::default(), &client);
             reporter.check_commit(&self.commit).await
         }
diff --git a/tooling/compliance/src/github.rs b/tooling/compliance/src/github.rs
@@ -9,15 +9,15 @@ use crate::git::CommitSha;
 pub const PR_REVIEW_LABEL: &str = "PR state:needs review";
 
 #[derive(Debug, Clone)]
-pub struct GitHubUser {
+pub struct GithubUser {
     pub login: String,
 }
 
 #[derive(Debug, Clone)]
 pub struct PullRequestData {
     pub number: u64,
-    pub user: Option<GitHubUser>,
-    pub merged_by: Option<GitHubUser>,
+    pub user: Option<GithubUser>,
+    pub merged_by: Option<GithubUser>,
     pub labels: Option<Vec<String>>,
 }
 
@@ -29,7 +29,7 @@ pub enum ReviewState {
 
 #[derive(Debug, Clone)]
 pub struct PullRequestReview {
-    pub user: Option<GitHubUser>,
+    pub user: Option<GithubUser>,
     pub state: Option<ReviewState>,
     pub body: Option<String>,
 }
@@ -45,7 +45,7 @@ impl PullRequestReview {
 
 #[derive(Debug, Clone)]
 pub struct PullRequestComment {
-    pub user: GitHubUser,
+    pub user: GithubUser,
     pub body: Option<String>,
 }
 
@@ -176,7 +176,7 @@ impl Repository<'static> {
 }
 
 #[async_trait::async_trait(?Send)]
-pub trait GitHubApiClient {
+pub trait GithubApiClient {
     async fn get_pull_request(
         &self,
         repo: &Repository<'_>,
@@ -211,12 +211,12 @@ pub trait GitHubApiClient {
 }
 
 #[derive(Deref)]
-pub struct GitHubClient {
-    api: Rc<dyn GitHubApiClient>,
+pub struct GithubClient {
+    api: Rc<dyn GithubApiClient>,
 }
 
-impl GitHubClient {
-    pub fn new(api: Rc<dyn GitHubApiClient>) -> Self {
+impl GithubClient {
+    pub fn new(api: Rc<dyn GithubApiClient>) -> Self {
         Self { api }
     }
 
@@ -333,7 +333,7 @@ mod octo_client {
     };
 
     use super::{
-        AuthorsForCommits, GitHubApiClient, GitHubUser, GithubLogin, PullRequestComment,
+        AuthorsForCommits, GithubApiClient, GithubLogin, GithubUser, PullRequestComment,
         PullRequestData, PullRequestReview, ReviewState,
     };
 
@@ -406,7 +406,7 @@ mod octo_client {
     }
 
     #[async_trait::async_trait(?Send)]
-    impl GitHubApiClient for OctocrabClient {
+    impl GithubApiClient for OctocrabClient {
         async fn get_pull_request(
             &self,
             repo: &Repository<'_>,
@@ -419,8 +419,8 @@ mod octo_client {
                 .await?;
             Ok(PullRequestData {
                 number: pr.number,
-                user: pr.user.map(|user| GitHubUser { login: user.login }),
-                merged_by: pr.merged_by.map(|user| GitHubUser { login: user.login }),
+                user: pr.user.map(|user| GithubUser { login: user.login }),
+                merged_by: pr.merged_by.map(|user| GithubUser { login: user.login }),
                 labels: pr
                     .labels
                     .map(|labels| labels.into_iter().map(|label| label.name).collect()),
@@ -445,7 +445,7 @@ mod octo_client {
             Ok(reviews
                 .into_iter()
                 .map(|review| PullRequestReview {
-                    user: review.user.map(|user| GitHubUser { login: user.login }),
+                    user: review.user.map(|user| GithubUser { login: user.login }),
                     state: review.state.map(|state| match state {
                         OctocrabReviewState::Approved => ReviewState::Approved,
                         _ => ReviewState::Other,
@@ -473,7 +473,7 @@ mod octo_client {
             Ok(comments
                 .into_iter()
                 .map(|comment| PullRequestComment {
-                    user: GitHubUser {
+                    user: GithubUser {
                         login: comment.user.login,
                     },
                     body: comment.body,
diff --git a/tooling/compliance/src/report.rs b/tooling/compliance/src/report.rs
@@ -306,7 +306,7 @@ mod tests {
     use crate::{
         checks::{ReviewFailure, ReviewSuccess},
         git::{CommitDetails, CommitList},
-        github::{GitHubUser, PullRequestReview, ReviewState},
+        github::{GithubUser, PullRequestReview, ReviewState},
     };
 
     use super::{Report, ReportReviewSummary};
@@ -330,7 +330,7 @@ mod tests {
 
     fn reviewed() -> ReviewSuccess {
         ReviewSuccess::PullRequestReviewed(vec![PullRequestReview {
-            user: Some(GitHubUser {
+            user: Some(GithubUser {
                 login: "reviewer".to_owned(),
             }),
             state: Some(ReviewState::Approved),
diff --git a/tooling/xtask/src/tasks/compliance.rs b/tooling/xtask/src/tasks/compliance.rs
@@ -6,7 +6,7 @@ use clap::Parser;
 use compliance::{
     checks::Reporter,
     git::{CommitsFromVersionToVersion, GetVersionTags, GitCommand, VersionTag},
-    github::{GitHubClient, Repository},
+    github::{GithubClient, Repository},
     report::ReportReviewSummary,
 };
 
@@ -69,7 +69,7 @@ async fn check_compliance_impl(args: ComplianceArgs) -> Result<()> {
 
     println!("Checking commit range {range}, {} total", commits.len());
 
-    let client = GitHubClient::for_app_in_repo(
+    let client = GithubClient::for_app_in_repo(
         app_id.parse().context("Failed to parse app ID as int")?,
         key.as_ref(),
         Repository::ZED.owner(),
