feat(github): add skipPersonalRepos toggle to mirror only org repos (#304) (#320)

- Add `skipPersonalRepos: z.boolean().default(false)` to githubConfigSchema
- Filter out user-owned repos in getGithubRepositories when flag is true
- Wire ONLY_MIRROR_ORGS env var to skipPersonalRepos in env-config-loader
- Add checkbox UI in GitHubMirrorSettings Filtering & Behavior section
- Round-trip skipPersonalRepos through config-mapper (UI ↔ DB)
- Add skipPersonalRepos to AdvancedOptions TypeScript type
- Mark include/exclude arrays in configSchema as unused/reserved
- Update ENVIRONMENT_VARIABLES.md to document ONLY_MIRROR_ORGS effect
This commit is contained in:
ARUNAVO RAY
2026-06-13 08:00:50 +05:30
committed by GitHub
parent 7610a614da
commit 0b6b6b76bf
9 changed files with 150 additions and 11 deletions
+1 -1
View File
@@ -114,7 +114,7 @@ Standard GitHub Enterprise Cloud on `github.com` works with the default — no o
|----------|-------------|---------|---------|
| `MIRROR_ORGANIZATIONS` | Mirror organization repositories | `false` | `true`, `false` |
| `PRESERVE_ORG_STRUCTURE` | Preserve GitHub organization structure in Gitea | `false` | `true`, `false` |
| `ONLY_MIRROR_ORGS` | Only mirror organization repos (skip personal) | `false` | `true`, `false` |
| `ONLY_MIRROR_ORGS` | Only mirror organization repos (skip personal); sets `skipPersonalRepos: true` in GitHub config | `false` | `true`, `false` |
| `MIRROR_STRATEGY` | Repository organization strategy | `preserve` | `preserve`, `single-org`, `flat-user`, `mixed` |
### Advanced Settings
@@ -927,6 +927,26 @@ export function GitHubMirrorSettings({
</p>
</div>
</div>
<div className="flex items-start space-x-3">
<Checkbox
id="skip-personal-repos"
checked={advancedOptions.skipPersonalRepos ?? false}
onCheckedChange={(checked) => handleAdvancedChange('skipPersonalRepos', !!checked)}
/>
<div className="space-y-0.5 flex-1">
<Label
htmlFor="skip-personal-repos"
className="text-sm font-normal cursor-pointer flex items-center gap-2"
>
<Users className="h-3.5 w-3.5" />
Skip personal repositories (only mirror organization repos)
</Label>
<p className="text-xs text-muted-foreground">
Exclude repositories owned by your personal GitHub account; only mirror repos belonging to organizations
</p>
</div>
</div>
</div>
</div>
</div>
+3
View File
@@ -34,6 +34,7 @@ export const githubConfigSchema = z.object({
autoMirrorStarred: z.boolean().default(false),
skipStarredIssues: z.boolean().optional(), // Deprecated: kept for backward compatibility, use starredCodeOnly instead
starredDuplicateStrategy: z.enum(["suffix", "prefix", "owner-org"]).default("suffix").optional(),
skipPersonalRepos: z.boolean().default(false),
});
export const backupStrategyEnum = z.enum([
@@ -156,7 +157,9 @@ export const configSchema = z.object({
isActive: z.boolean().default(true),
githubConfig: githubConfigSchema,
giteaConfig: giteaConfigSchema,
// Unused/reserved — stored for future glob support but not currently read
include: z.array(z.string()).default(["*"]),
// Unused/reserved — stored for future glob support but not currently read
exclude: z.array(z.string()).default([]),
scheduleConfig: scheduleConfigSchema,
cleanupConfig: cleanupConfigSchema,
+2
View File
@@ -285,6 +285,8 @@ export async function initializeConfigFromEnv(): Promise<void> {
starredCodeOnly: envConfig.github.starredCodeOnly ?? existingConfig?.[0]?.githubConfig?.starredCodeOnly ?? false,
autoMirrorStarred: envConfig.github.autoMirrorStarred ?? existingConfig?.[0]?.githubConfig?.autoMirrorStarred ?? false,
starredLists: envConfig.github.starredLists ?? existingConfig?.[0]?.githubConfig?.starredLists ?? [],
// ONLY_MIRROR_ORGS=true maps to skipPersonalRepos: true
skipPersonalRepos: envConfig.github.onlyMirrorOrgs ?? existingConfig?.[0]?.githubConfig?.skipPersonalRepos ?? false,
};
// Build Gitea config
+75 -9
View File
@@ -1,15 +1,23 @@
import { describe, expect, test, mock } from "bun:test";
import { getGithubRepositories } from "@/lib/github";
function makeRepo() {
function makeRepo(overrides: Partial<{
name: string;
full_name: string;
ownerLogin: string;
ownerType: string;
fork: boolean;
}> = {}) {
const ownerLogin = overrides.ownerLogin ?? "octo";
const ownerType = overrides.ownerType ?? "User";
return {
name: "demo",
full_name: "octo/demo",
html_url: "https://github.com/octo/demo",
clone_url: "https://github.com/octo/demo.git",
owner: { login: "octo", type: "User" },
name: overrides.name ?? "demo",
full_name: overrides.full_name ?? `${ownerLogin}/${overrides.name ?? "demo"}`,
html_url: `https://github.com/${ownerLogin}/${overrides.name ?? "demo"}`,
clone_url: `https://github.com/${ownerLogin}/${overrides.name ?? "demo"}.git`,
owner: { login: ownerLogin, type: ownerType },
private: false,
fork: false,
fork: overrides.fork ?? false,
has_issues: true,
archived: false,
size: 1,
@@ -23,11 +31,11 @@ function makeRepo() {
};
}
function makeOctokit() {
function makeOctokit(reposToReturn?: ReturnType<typeof makeRepo>[]) {
let captured: Record<string, unknown> | null = null;
const paginate = mock(async (_method: unknown, options?: Record<string, unknown>) => {
captured = options ?? null;
return [makeRepo()];
return reposToReturn ?? [makeRepo()];
});
return {
octokit: {
@@ -98,3 +106,61 @@ describe("getGithubRepositories - affiliation", () => {
}
});
});
describe("getGithubRepositories - skipPersonalRepos", () => {
const personalRepo = makeRepo({ name: "my-lib", ownerLogin: "octo", ownerType: "User" });
const orgRepo = makeRepo({ name: "org-lib", ownerLogin: "my-org", ownerType: "Organization" });
const otherUserRepo = makeRepo({ name: "collab-lib", ownerLogin: "other-user", ownerType: "User" });
test("default false — keeps all repos including personal", async () => {
const { octokit } = makeOctokit([personalRepo, orgRepo]);
const repos = await getGithubRepositories({
octokit,
config: { githubConfig: { owner: "octo", skipPersonalRepos: false } as any },
});
expect(repos.map((r) => r.name)).toContain("my-lib");
expect(repos.map((r) => r.name)).toContain("org-lib");
});
test("skipPersonalRepos=true — drops repos owned by authenticated user", async () => {
const { octokit } = makeOctokit([personalRepo, orgRepo]);
const repos = await getGithubRepositories({
octokit,
config: { githubConfig: { owner: "octo", skipPersonalRepos: true } as any },
});
expect(repos.map((r) => r.name)).not.toContain("my-lib");
expect(repos.map((r) => r.name)).toContain("org-lib");
});
test("skipPersonalRepos=true — keeps repos owned by other users (collaborator repos)", async () => {
const { octokit } = makeOctokit([personalRepo, orgRepo, otherUserRepo]);
const repos = await getGithubRepositories({
octokit,
config: { githubConfig: { owner: "octo", skipPersonalRepos: true } as any },
});
expect(repos.map((r) => r.name)).not.toContain("my-lib");
expect(repos.map((r) => r.name)).toContain("org-lib");
expect(repos.map((r) => r.name)).toContain("collab-lib");
});
test("skipPersonalRepos=true with no owner configured — keeps all repos (safe fallback)", async () => {
const { octokit } = makeOctokit([personalRepo, orgRepo]);
const repos = await getGithubRepositories({
octokit,
config: { githubConfig: { owner: "", skipPersonalRepos: true } as any },
});
// Empty owner means we can't identify the user, so nothing should be dropped
expect(repos.map((r) => r.name)).toContain("my-lib");
expect(repos.map((r) => r.name)).toContain("org-lib");
});
test("skipPersonalRepos=true — unset (undefined) behaves like false", async () => {
const { octokit } = makeOctokit([personalRepo, orgRepo]);
const repos = await getGithubRepositories({
octokit,
config: { githubConfig: { owner: "octo" } as any },
});
expect(repos.map((r) => r.name)).toContain("my-lib");
expect(repos.map((r) => r.name)).toContain("org-lib");
});
});
+12 -1
View File
@@ -263,10 +263,21 @@ export async function getGithubRepositories({
);
const skipForks = config.githubConfig?.skipForks ?? false;
const skipPersonalRepos = config.githubConfig?.skipPersonalRepos ?? false;
// The authenticated user's login — used to identify personally-owned repos
const authenticatedUserLogin = config.githubConfig?.owner ?? "";
const filteredRepos = repos.filter((repo) => {
const isForkAllowed = !skipForks || !repo.fork;
return isForkAllowed;
// When skipPersonalRepos is true, drop repos owned by the authenticated user
// (owner.type === "User" and owner.login matches the configured GitHub username).
// Org repos have owner.type === "Organization" so they are always kept.
const isPersonalRepo =
skipPersonalRepos &&
authenticatedUserLogin.length > 0 &&
repo.owner.login === authenticatedUserLogin &&
repo.owner.type === "User";
return isForkAllowed && !isPersonalRepo;
});
return filteredRepos.map((repo) => ({
+34
View File
@@ -124,3 +124,37 @@ test("githubConfigSchema parses includeCollaboratorRepos with true default", ()
});
expect(parsed.includeCollaboratorRepos).toBe(true);
});
test("skipPersonalRepos defaults to false in githubConfigSchema", () => {
const parsed = githubConfigSchema.parse({
owner: "octo",
type: "personal",
token: "",
});
expect(parsed.skipPersonalRepos).toBe(false);
});
test("skipPersonalRepos round-trips UI -> DB -> UI when true", () => {
const ui = buildMinimalUiConfigs();
const advancedWithSkip: AdvancedOptions = { ...ui.advancedOptions, skipPersonalRepos: true };
const db = mapUiToDbConfig(ui.githubConfig, ui.giteaConfig, ui.mirrorOptions, advancedWithSkip);
expect(db.githubConfig.skipPersonalRepos).toBe(true);
const roundTripped = mapDbToUiConfig({ githubConfig: db.githubConfig, giteaConfig: db.giteaConfig });
expect(roundTripped.advancedOptions.skipPersonalRepos).toBe(true);
});
test("skipPersonalRepos round-trips UI -> DB -> UI when false", () => {
const ui = buildMinimalUiConfigs();
const advancedWithSkip: AdvancedOptions = { ...ui.advancedOptions, skipPersonalRepos: false };
const db = mapUiToDbConfig(ui.githubConfig, ui.giteaConfig, ui.mirrorOptions, advancedWithSkip);
expect(db.githubConfig.skipPersonalRepos).toBe(false);
const roundTripped = mapDbToUiConfig({ githubConfig: db.githubConfig, giteaConfig: db.giteaConfig });
expect(roundTripped.advancedOptions.skipPersonalRepos).toBe(false);
});
test("DB row missing skipPersonalRepos defaults to false on read", () => {
const ui = mapDbToUiConfig({ githubConfig: { owner: "octo", token: "" } });
expect(ui.advancedOptions.skipPersonalRepos).toBe(false);
});
+2
View File
@@ -71,6 +71,7 @@ export function mapUiToDbConfig(
// Advanced options
starredCodeOnly: advancedOptions.starredCodeOnly,
autoMirrorStarred: advancedOptions.autoMirrorStarred ?? false,
skipPersonalRepos: advancedOptions.skipPersonalRepos ?? false,
};
// Map Gitea config to match database schema
@@ -194,6 +195,7 @@ export function mapDbToUiConfig(dbConfig: any): {
// Support both old (skipStarredIssues) and new (starredCodeOnly) field names for backward compatibility
starredCodeOnly: dbConfig.githubConfig?.starredCodeOnly ?? (dbConfig.githubConfig as any)?.skipStarredIssues ?? false,
autoMirrorStarred: dbConfig.githubConfig?.autoMirrorStarred ?? false,
skipPersonalRepos: dbConfig.githubConfig?.skipPersonalRepos ?? false,
};
return {
+1
View File
@@ -86,6 +86,7 @@ export interface AdvancedOptions {
skipForks: boolean;
starredCodeOnly: boolean;
autoMirrorStarred?: boolean;
skipPersonalRepos?: boolean;
}
export interface SaveConfigApiRequest {