Merge pull request #204 from github-community-projects/sutterj/code-r…

…ename

feat: rename icf to pma in code

.github/workflows/docker-build.yml

@@ -14,4 +14,4 @@ jobs:
         uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # pin@v4
 
       - name: Build Docker image
-        run: docker build -t internal-contribution-forks .
+        run: docker build -t private-mirrors .

package.json

@@ -1,11 +1,11 @@
 {
-  "name": "internal-contribution-forks",
+  "name": "private-mirrors",
   "version": "0.1.0",
   "private": true,
   "description": "A GitHub App that allows you to contribute upstream using a 'private fork'",
   "author": "Andrew Henry <ajhenry@github.com>",
   "license": "MIT",
-  "homepage": "https://github.com/github-community-projects/internal-contribution-forks",
+  "homepage": "https://github.com/github-community-projects/private-mirrors",
   "scripts": {
     "dev": "concurrently -c \"auto\" -n webhooks,app  \"dotenv-load node scripts/webhook-relay.mjs\" \"next dev\"",
     "webhook": "dotenv-load node scripts/webhook-relay.mjs",

src/app/components/header/MainHeader.tsx

@@ -22,7 +22,7 @@ export const MainHeader = () => {
       </Header.Item>
       <Header.Item full>
         <Text sx={{ color: 'fg.default', fontSize: '2', fontWeight: 'bold' }}>
-          Internal Contribution Forks
+          Private Mirrors
         </Text>
       </Header.Item>
       {session && session.data?.user && (

src/app/components/header/WelcomeHeader.tsx

@@ -11,7 +11,7 @@ export const WelcomeHeader = () => {
         </Stack.Item>
         <Stack.Item>
           <Text sx={{ color: 'fg.default', fontSize: '3', fontWeight: 'bold' }}>
-            Welcome to Internal Contribution Forks!
+            Welcome to Private Mirrors App!
           </Text>
         </Stack.Item>
       </Stack>

src/app/components/login/Login.tsx

@@ -41,7 +41,7 @@ export const Login = () => {
           </Box>
           <Box sx={{ textAlign: 'center' }}>
             <Text sx={{ fontSize: '1', color: 'fg.muted' }}>
-              Internal Contribution Forks
+              Private Mirrors
             </Text>
           </Box>
         </Box>

src/bot/config.ts

@@ -5,15 +5,12 @@ import { appOctokit, installationOctokit } from './octokit'
 
 const configLogger = logger.getSubLogger({ name: 'config' })
 
-const internalContributionForksConfig = z.object({
+const pmaConfig = z.object({
   publicOrg: z.string(),
   privateOrg: z.string(),
 })
 
-type InternalContributionForksConfig = z.infer<
-  typeof internalContributionForksConfig
-> &
-  Configuration
+type pmaConfig = z.infer<typeof pmaConfig> & Configuration
 
 export const getGitHubConfig = async (orgId: string) => {
   const installationId = await appOctokit().rest.apps.getOrgInstallation({
@@ -44,17 +41,17 @@ export const getEnvConfig = () => {
   const config = {
     publicOrg: process.env.PUBLIC_ORG,
     privateOrg: process.env.PUBLIC_ORG,
-  } as InternalContributionForksConfig
+  } as pmaConfig
 
   if (process.env.PRIVATE_ORG) {
     config.privateOrg = process.env.PRIVATE_ORG
   }
   return config
 }
 
-export const validateConfig = (config: InternalContributionForksConfig) => {
+export const validateConfig = (config: pmaConfig) => {
   try {
-    internalContributionForksConfig.parse(config)
+    pmaConfig.parse(config)
   } catch (error) {
     configLogger.error('Invalid config found!', { error })
     throw new Error(
@@ -71,7 +68,7 @@ export const validateConfig = (config: InternalContributionForksConfig) => {
  * @returns Configuration file
  */
 export const getConfig = async (orgId?: string) => {
-  let config: InternalContributionForksConfig | null = null
+  let config: pmaConfig | null = null
 
   // First check for environment variables
   config = getEnvConfig()

src/bot/rules.ts

@@ -35,7 +35,7 @@ export const createAllPushProtection = async (
     await createBranchProtectionRuleset(
       context,
       actorNodeId,
-      'all-branch-protections-icf',
+      'all-branch-protections-pma',
       ['~ALL'],
     )
   } catch (error) {
@@ -96,7 +96,7 @@ export const createDefaultBranchProtection = async (
     await createBranchProtectionRuleset(
       context,
       actorNodeId,
-      'default-branch-protection-icf',
+      'default-branch-protection-pma',
       ['~DEFAULT_BRANCH'],
       true,
     )

src/server/git/controller.ts

@@ -60,8 +60,8 @@ export const syncReposHandler = async ({
 
     const options: Partial<SimpleGitOptions> = {
       config: [
-        `user.name=internal-contribution-forks[bot]`,
-        `user.email=${privateInstallationId}+internal-contribution-forks[bot]@users.noreply.github.com`,
+        `user.name=pma[bot]`,
+        `user.email=${privateInstallationId}+pma[bot]@users.noreply.github.com`,
         // Disable any global git hooks to prevent potential interference when running the app locally
         'core.hooksPath=/dev/null',
       ],

src/server/repos/controller.ts

@@ -90,9 +90,9 @@ export const createMirrorHandler = async ({
 
       const options: Partial<SimpleGitOptions> = {
         config: [
-          `user.name=internal-contribution-forks[bot]`,
+          `user.name=pma[bot]`,
           // We want to use the private installation ID as the email so that we can push to the private repo
-          `user.email=${privateInstallationId}+internal-contribution-forks[bot]@users.noreply.github.com`,
+          `user.email=${privateInstallationId}+pma[bot]@users.noreply.github.com`,
           // Disable any global git hooks to prevent potential interference when running the app locally
           'core.hooksPath=/dev/null',
         ],

test/app.test.ts

@@ -90,7 +90,7 @@ describe('Webhooks events', () => {
           query: forkBranchProtectionRulesetGQL,
           variables: {
             repositoryId: forkCreatedPayload.repository.node_id,
-            ruleName: 'all-branch-protections-icf',
+            ruleName: 'all-branch-protections-pma',
           },
         })
         return body
@@ -155,7 +155,7 @@ describe('Webhooks events', () => {
           query: mirrorBranchProtectionRulesetGQL,
           variables: {
             repositoryId: mirrorCreatedPayload.repository.node_id,
-            ruleName: 'default-branch-protection-icf',
+            ruleName: 'default-branch-protection-pma',
           },
         })
         return body

test/config.test.ts

@@ -8,7 +8,7 @@ jest.mock('../src/bot/octokit', () => ({
   installationOctokit: () => om.getOctokitImplementation(),
 }))
 
-describe('ICF Config', () => {
+describe('PMA Config', () => {
   beforeEach(() => {
     jest.resetAllMocks()
     delete process.env.PUBLIC_ORG

test/fixtures/mirror.created.json

@@ -130,22 +130,22 @@
     "updated_at": "2023-10-16T19:51:20Z"
   },
   "sender": {
-    "login": "icf-sutterj[bot]",
+    "login": "pma-sutterj[bot]",
     "id": 165810367,
     "node_id": "BOT_kgDOCeIQvw",
     "avatar_url": "https://avatars.githubusercontent.com/u/22358079?v=4",
     "gravatar_id": "",
-    "url": "https://api.github.com/users/icf-sutterj%5Bbot%5D",
-    "html_url": "https://github.com/apps/icf-sutterj",
-    "followers_url": "https://api.github.com/users/icf-sutterj%5Bbot%5D/followers",
-    "following_url": "https://api.github.com/users/icf-sutterj%5Bbot%5D/following{/other_user}",
-    "gists_url": "https://api.github.com/users/icf-sutterj%5Bbot%5D/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/icf-sutterj%5Bbot%5D/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/icf-sutterj%5Bbot%5D/subscriptions",
-    "organizations_url": "https://api.github.com/users/icf-sutterj%5Bbot%5D/orgs",
-    "repos_url": "https://api.github.com/users/icf-sutterj%5Bbot%5D/repos",
-    "events_url": "https://api.github.com/users/icf-sutterj%5Bbot%5D/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/icf-sutterj%5Bbot%5D/received_events",
+    "url": "https://api.github.com/users/pma-sutterj%5Bbot%5D",
+    "html_url": "https://github.com/apps/pma-sutterj",
+    "followers_url": "https://api.github.com/users/pma-sutterj%5Bbot%5D/followers",
+    "following_url": "https://api.github.com/users/pma-sutterj%5Bbot%5D/following{/other_user}",
+    "gists_url": "https://api.github.com/users/pma-sutterj%5Bbot%5D/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/pma-sutterj%5Bbot%5D/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/pma-sutterj%5Bbot%5D/subscriptions",
+    "organizations_url": "https://api.github.com/users/pma-sutterj%5Bbot%5D/orgs",
+    "repos_url": "https://api.github.com/users/pma-sutterj%5Bbot%5D/repos",
+    "events_url": "https://api.github.com/users/pma-sutterj%5Bbot%5D/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/pma-sutterj%5Bbot%5D/received_events",
     "type": "Bot",
     "site_admin": false
   },