Added configuration of git remotes to dev container setup (TryGhost#2…

…1458)

no issue

- Added function to Dev Container onCreateCommand to setup git remotes
when creating the Dev Container
- If `$GHOST_UPSTREAM` is set, it will rename the default `origin`
remote to its value
- It will also update the remotes for the submodules, otherwise `yarn
main` will fail
- If `$GHOST_FORK_REMOTE_URL` is set, it will add it as `origin`, or the
value of `$GHOST_FORK_REMOTE_NAME` if set.
- If `$GHOST_FORCE_SSH` is set to `true`, it will change all remotes
URL's to use ssh instead of https

.devcontainer/devcontainer.json

@@ -16,7 +16,11 @@
         "MAILGUN_SMTP_PASS": "${localEnv:MAILGUN_SMTP_PASS}",
         "MAILGUN_FROM_ADDRESS": "${localEnv:MAILGUN_FROM_ADDRESS}",
         "MAILGUN_API_KEY": "${localEnv:MAILGUN_API_KEY}",
-        "MAILGUN_DOMAIN": "${localEnv:MAILGUN_DOMAIN}"
+        "MAILGUN_DOMAIN": "${localEnv:MAILGUN_DOMAIN}",
+        "GHOST_UPSTREAM": "${localEnv:GHOST_UPSTREAM}",
+        "GHOST_FORK_REMOTE_URL": "${localEnv:GHOST_FORK_REMOTE_URL}",
+        "GHOST_FORK_REMOTE_NAME": "${localEnv:GHOST_FORK_REMOTE_NAME}",
+        "GHOST_FORCE_SSH": "${localEnv:GHOST_FORCE_SSH}"
     },
     "forwardPorts": [2368,4200],
     "portsAttributes": {

.devcontainer/onCreateCommand.js

@@ -7,6 +7,7 @@ const { execSync } = require('child_process');
 
 // Main function that runs all the setup steps
 function main() {
+    setupGitRemotes();
     setupLocalConfig();
     runCleanHard();
     runInstall();
@@ -35,6 +36,61 @@ function logError(message, error) {
     console.error(`${colors.red}${message}${colors.reset}`, error);
 }
 
+// Sets up the git remotes for the dev container based on environment variables
+function setupGitRemotes() {
+    log('Configuring git remotes...', colors.blue);
+    try {
+        const GHOST_UPSTREAM = process.env.GHOST_UPSTREAM;
+        const GHOST_FORK_REMOTE_URL = process.env.GHOST_FORK_REMOTE_URL;
+        const GHOST_FORK_REMOTE_NAME = process.env.GHOST_FORK_REMOTE_NAME;
+        const GHOST_FORCE_SSH = process.env.GHOST_FORCE_SSH;
+        let remotes = execSync('git remote').toString().trim().split('\n');
+
+        if (GHOST_UPSTREAM) {
+            // Check if the upstream remote already exists
+            if (!remotes.includes(GHOST_UPSTREAM) && remotes.includes('origin')) {
+                log(`Renaming the default remote from origin to ${GHOST_UPSTREAM}...`, colors.blue);
+                execSync(`git remote rename origin ${GHOST_UPSTREAM}`);
+            }
+        }
+
+        if (GHOST_FORK_REMOTE_URL) {
+            const remoteName = GHOST_FORK_REMOTE_NAME || 'origin';
+            // Check if the fork remote already exists
+            if (!remotes.includes(remoteName)) {
+                log(`Adding fork remote ${GHOST_FORK_REMOTE_URL} as ${remoteName}...`, colors.blue);
+                execSync(`git remote add ${remoteName} ${GHOST_FORK_REMOTE_URL}`);
+            }
+        }
+
+        if (GHOST_FORCE_SSH) {
+            log('Forcing SSH for all remotes...', colors.blue);
+            // Get all remotes
+            remotes = execSync('git remote').toString().trim().split('\n');
+
+            for (const remote of remotes) {
+                // Get the current URL for this remote
+                const url = execSync(`git remote get-url ${remote}`).toString().trim();
+
+                // Only convert if it's an HTTPS URL
+                if (url.startsWith('https://')) {
+                    // Convert HTTPS to SSH format
+                    // https://github.com/user/repo.git -> git@github.com:user/repo.git
+                    const sshUrl = url
+                        .replace(/^https:\/\//, 'git@')
+                        .replace(/\//, ':');
+
+                    log(`Converting ${remote} from HTTPS to SSH...`, colors.dim);
+                    execSync(`git remote set-url ${remote} ${sshUrl}`);
+                }
+            }
+        }
+
+    } catch (error) {
+        logError('Error setting up git remotes:', error);
+    }
+}
+
 // Creates config.local.json file with the correct values for the devcontainer
 function setupLocalConfig() {
     log('Setting up local config file...', colors.blue);
@@ -157,6 +213,13 @@ function runSubmoduleUpdate() {
     try {
         log('Updating git submodules...', colors.blue);
         execSync('git submodule update --init --recursive', { stdio: 'inherit' });
+        // Rename the default remote to $GHOST_UPSTREAM if it's set
+        // Otherwise `yarn main:submodules` will fail
+        const GHOST_UPSTREAM = process.env.GHOST_UPSTREAM;
+        if (GHOST_UPSTREAM) {
+            execSync(`git submodule foreach "git remote | grep -q '^${GHOST_UPSTREAM}$' || (git remote | grep -q '^origin$' && git remote rename origin ${GHOST_UPSTREAM})"`);
+        }
+
         log('Successfully ran git submodule update', colors.dim);
     } catch (error) {
         logError('Error running git submodule update:', error);