Skip to content

Add support for syncing GitHub App installation repos with GitHub app auth #2393

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

Draft
Kobzol wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add support for syncing GitHub App installation repos with GitHub app auth #2393

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
116 changes: 89 additions & 27 deletions src/sync/github/api/write.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ use log::debug;
use reqwest::Method;
use std::collections::HashSet;

use crate::sync::github::api::url::GitHubUrl;
use crate::sync::github::api::url::{GitHubUrl, TokenType};
use crate::sync::github::api::{
AppPushAllowanceActor, BranchProtection, BranchProtectionOp, GitHubApiRead, GithubRead,
HttpClient, Login, PushAllowanceActor, Repo, RepoPermission, RepoSettings, Ruleset, RulesetOp,
Expand Down Expand Up @@ -295,51 +295,113 @@ impl GitHubWrite {
pub(crate) async fn add_repo_to_app_installation(
&self,
installation_id: u64,
repository: &str,
repository_id: u64,
org: &str,
) -> anyhow::Result<()> {
debug!("Adding repository {repository_id} to installation {installation_id}");
if !self.dry_run {
self.client
.req(
Method::PUT,
&GitHubUrl::new(
&format!(
"user/installations/{installation_id}/repositories/{repository_id}"
if self.client.uses_pat() {
self.client
.req(
Method::PUT,
&GitHubUrl::new(
&format!(
"user/installations/{installation_id}/repositories/{repository_id}"
),
org,
),
org,
),
)?
.send()
.await?
.custom_error_for_status()
.await?;
)?
.send()
.await?
.custom_error_for_status()
.await?;
} else {
// We have to use a different endpoint if we use enterprise GitHub app
// authentication
#[derive(serde::Serialize)]
struct Request<'a> {
repositories: Vec<&'a str>,
}

// https://docs.github.com/en/enterprise-cloud@latest/rest/enterprise-admin/organization-installations?apiVersion=2026-03-10#grant-repository-access-to-an-organization-installation
self.client
.req(
Method::PATCH,
&GitHubUrl::new(
&format!(
"enterprises/{}/apps/organizations/{org}/installations/{installation_id}/repositories/add",
self.client.github_tokens.get_enterprise_name()?
),
org,
)
.with_token_type(TokenType::Enterprise),
)?
.json(&Request {
repositories: vec![repository]
})
.send()
.await?
.custom_error_for_status()
.await?;
}
}
Ok(())
}

pub(crate) async fn remove_repo_from_app_installation(
&self,
installation_id: u64,
repository: &str,
repository_id: u64,
org: &str,
) -> anyhow::Result<()> {
debug!("Removing repository {repository_id} from installation {installation_id}");
if !self.dry_run {
self.client
.req(
Method::DELETE,
&GitHubUrl::new(
&format!(
"user/installations/{installation_id}/repositories/{repository_id}"
if self.client.uses_pat() {
self.client
.req(
Method::DELETE,
&GitHubUrl::new(
&format!(
"user/installations/{installation_id}/repositories/{repository_id}"
),
org,
),
org,
),
)?
.send()
.await?
.custom_error_for_status()
.await?;
)?
.send()
.await?
.custom_error_for_status()
.await?;
} else {
// We have to use a different endpoint if we use enterprise GitHub app
// authentication
#[derive(serde::Serialize)]
struct Request<'a> {
repositories: Vec<&'a str>,
}

// https://docs.github.com/en/enterprise-cloud@latest/rest/enterprise-admin/organization-installations?apiVersion=2026-03-10#remove-repository-access-from-an-organization-installation
self.client
.req(
Method::PATCH,
&GitHubUrl::new(
&format!(
"enterprises/{}/apps/organizations/{org}/installations/{installation_id}/repositories/remove",
self.client.github_tokens.get_enterprise_name()?
),
org,
)
.with_token_type(TokenType::Enterprise),
)?
.json(&Request {
repositories: vec![repository]
})
.send()
.await?
.custom_error_for_status()
.await?;
}
}
Ok(())
}
Expand Down
25 changes: 19 additions & 6 deletions src/sync/github/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1480,7 +1480,9 @@ impl CreateRepoDiff {
}

for installation in &self.app_installations {
installation.apply(sync, repo.repo_id, &self.org).await?;
installation
.apply(sync, &self.org, &repo.name, repo.repo_id)
.await?;
}

Ok(())
Expand Down Expand Up @@ -1681,7 +1683,7 @@ impl UpdateRepoDiff {

for app_installation in &self.app_installation_diffs {
app_installation
.apply(sync, self.repo_id, &self.org)
.apply(sync, &self.org, &self.name, self.repo_id)
.await?;
}

Expand Down Expand Up @@ -2757,15 +2759,26 @@ enum AppInstallationDiff {
}

impl AppInstallationDiff {
async fn apply(&self, sync: &GitHubWrite, repo_id: u64, org: &str) -> anyhow::Result<()> {
async fn apply(
&self,
sync: &GitHubWrite,
org: &str,
repo_name: &str,
repo_id: u64,
) -> anyhow::Result<()> {
match self {
AppInstallationDiff::Add(app) => {
sync.add_repo_to_app_installation(app.installation_id, repo_id, org)
sync.add_repo_to_app_installation(app.installation_id, repo_name, repo_id, org)
.await?;
}
AppInstallationDiff::Remove(app) => {
sync.remove_repo_from_app_installation(app.installation_id, repo_id, org)
.await?;
sync.remove_repo_from_app_installation(
app.installation_id,
repo_name,
repo_id,
org,
)
.await?;
}
}
Ok(())
Expand Down