From f2d1cea5e72742f624a601f45d62ebf05fdf48d0 Mon Sep 17 00:00:00 2001 From: Marine Dunstetter Date: Wed, 10 Jan 2024 10:58:31 +0100 Subject: [PATCH] Improve catchup script (#236) * feat(catchup script): delete the current script to rewrite it with a clear stack * feat(catchup script): create a script that switch to a new working branch and update the English branch we need to compare current Ember version and new Ember version * feat(catchup script): output the list of files that changed between ref-upstream and upstream/master and parse it as an array of filenames * feat(catchup script): make the name of the branch dynamic by passing arguments to the script * feat(catchup script): create a directory to put patch files we want to create for each changed file * feat(catchup script): prepare a list of warnings to log all manual actions required at the end of the process * feat(catchup script): create the function that will output the diff files in the script/patches folder * feat(catchup script): declare an array filesToPost that will be used to track the files to post in a GitHub issue * feat(catchup script): create the function that loop on the changed files to create the diff files * feat(catchup script): once a diff file is create, read its content. We need to do this because we want to do a replacement in the content * feat(catchup script): for each file, remove the term release/ from the filename and from the content of the diff * feat(catchup script): for each diff file, rewrite the content with the updated path, so the file can be patched in our architecture * feat(catchup script): try to apply the patch. If the file is new or if git apply fails (file translated), then we add to filesToPost to open a GitHub issue later * feat(catchup script): add a relevant return to the writeDiffFiles function so we know if there are patch files to commit and push * feat(catchup script): prepare the header to post the GitHub issues. It requires to read the secret token. * feat(catchup script): prepare the body of the GitHub issue for a given file and diff. There's no diff block if the file is new * feat(catchup script): create the function that will post the GitHub issue for a given file * feat(catchup script): create and call the function that will post all the GitHub issues * feat(catchup script): if at least one file could be patched automatically, push the changes on GitHub * feat(catchup script): open the catchup PR when the changes could be pushed * feat(catchup script): prepare 3 functions to properly close the process. One reset ref-upstream then the other will switch back to master or the catchup branch depending on the situation * feat(catchup script): properly close the process, update ref-upstream only if we no longer need the current state (all operations to create/edit diff files are ok), and switch back to the best branch * feat(catchup script): print the warning messages also when the script ends with code 1 --- package.json | 3 +- scripts/catchup.mjs | 590 ++++++++++++++++++++++++++++++++------------ 2 files changed, 434 insertions(+), 159 deletions(-) diff --git a/package.json b/package.json index 7e8280146..ca0ccd73a 100644 --- a/package.json +++ b/package.json @@ -38,8 +38,7 @@ "test:ember": "ember test", "test:node": "mocha node-tests --exclude node-tests/local/**", "test:node-local": "mocha node-tests/local", - "test:node-local-exclude-api-urls": "FOLLOW_API_URLS=false npm run test:node-local", - "catchup": "node scripts/catchup.mjs" + "test:node-local-exclude-api-urls": "FOLLOW_API_URLS=false npm run test:node-local" }, "devDependencies": { "@ember/optional-features": "^2.0.0", diff --git a/scripts/catchup.mjs b/scripts/catchup.mjs index fc9a137bb..bc1bb7906 100644 --- a/scripts/catchup.mjs +++ b/scripts/catchup.mjs @@ -1,201 +1,282 @@ import 'dotenv/config'; -import fetch from 'node-fetch'; +import { execSync } from 'child_process'; import fs from 'fs'; import minimist from 'minimist-lite'; -import shell from 'shelljs'; // Declare repository -const repo = 'dazzlingfugu/ember-fr-guides-source'; +const repo = 'DazzlingFugu/ember-fr-guides-source'; // Read Github token const token = process.env.GITHUB_TOKEN; -// Read script arguments -const argv = minimist(process.argv.slice(2)); +/* + * Read script arguments + * We expect options "from" and "to" to have decimal values (e.g. 5.4, 6.0...) + * By default, minimist-lite would treat these values as numbers so "6.0" would be parsed as "6". + * This is not the intended behavior, so we specify that "from" and "to" should be treated as strings. + */ +const argv = minimist(process.argv.slice(2), { string: ['from', 'to'] }); +// Read current Ember version (under translation) const currentEmberVersion = `${argv.from}`; if (currentEmberVersion.match(/\d+[.]\d+/g)?.[0] !== currentEmberVersion) { - console.log('Error: please provide the current Ember version under translation to option --from (e.g. --from=5.1)'); + console.error('Error: please provide the current Ember version under translation to option --from (e.g. --from=5.1)'); process.exit(2); } console.log(`Ember version under translation: ${currentEmberVersion}`); +// Read new Ember version (documented by the English guides) const newEmberVersion = `${argv.to}`; if (newEmberVersion.match(/\d+[.]\d+/g)?.[0] !== newEmberVersion) { - console.log('Error: please provide the new Ember version documented on upstream to option --to (e.g. --to=5.4)'); + console.error('Error: please provide the new Ember version documented on upstream to option --to (e.g. --to=5.4)'); process.exit(2); } console.log(`New Ember version documented on upstream: ${newEmberVersion}`); -// Create a catchup branch out of the current branch (should be up to date master) +// Name of the catchup branch we will work on const catchupBranch = `catchup-${newEmberVersion}`; -if (shell.exec(`git switch --create ${catchupBranch}`).code !== 0) { - console.log(`shelljs: "git switch --create ${catchupBranch}" command failed`); - process.exit(1); -} -console.log(`shelljs: "git switch --create ${catchupBranch}" executed`); +// List of filenames that changed between origin/ref-upstream and upstream/master +let files; -// Fetch the latest updates in the official Ember Guides -if (shell.exec('git fetch upstream').code !== 0) { - console.log('shelljs: "git fetch upstream" command failed'); - process.exit(1); -} -console.log('shelljs: "git fetch upstream" executed'); +/* + * List of { filename, diffname } that require a GitHub issue to be adjusted manually + * Example: + * { filename: "my-page.md", diffName: "3.diff" } + * This mean that the diff between origin/ref-upstream and upstream/master for the file "my-page.md" + * has been printed in "3.diff". + * The command "git apply 3.diff" failed, probably because "my-page.md" was already translated into French. + * Therefore, we need to open a GitHub issue showing the diff English to English so translators know how to adjust the translation. + */ +let filesToPost = []; + +// List of manual actions to perform if the script encounters some failures +let warnings = []; + +// True if the ref-upstream branch cannot be updated because we need some manual checks between ref-upstream and upstream/master +let hasPendingDiff = false; + +// Some issues haven't been posted on Github, so it would be neat to stay on the catchup branch at the end of the process +let issuePostingError = false; -// Output the list of markdown files impacted by latest changes on upstream -if (shell.exec('git diff --name-only ref-upstream upstream/master -- guides/release > list.diff').code !== 0) { - console.log('shelljs: "git diff --name-only ref-upstream upstream/master -- guides/release > list.diff" command failed'); - process.exit(1); +/* + * This function executes a shell command using execSync with an additional log. + * If the command failed, execSync throws the error, so use runShell inside a try...catch. + */ +const runShell = (command) => { + console.log(`Attempting to execute: "${command}"`); + execSync(command); } -console.log('shelljs: "git diff --name-only ref-upstream upstream/master -- guides/release > list.diff" executed'); -// Read list.diff to extract the list of path to markdown files -let data = fs.readFileSync('list.diff', 'utf8'); -let files = data.split(/[\n\r]/).filter(name => name.length); -fs.unlink('list.diff', function(err) { - if (err) throw err; - console.log('list.diff did its job, deleted'); -}); +/* + * This function prints the messages stored in warnings. + * It should always be called before forcing the process to exit. + */ +const printWarningMessages = () => { + if (warnings.length > 0) { + console.log(` +The process has been completed with warnings. +Here are all the actions you should perform manually to fully complete it: -// Create a directory to put the children diff -fs.mkdirSync('scripts/patches'); -console.log('scripts/patches folder created to store the patch files'); +`); + for (const warning of warnings) { + console.warn(warning); + }; + } +} + +/* + * This function looks for the paths guides/release in the provided string and replace it with guides. + * We need this to adjust the paths to our scaffolding: + * The official English guides allow to navigate to legacy versions of Ember, it's "versioned" docs. + * The French guides show only the latest version, so we don't have a dropdown to navigate, it's "unversioned" docs. + * It's the scaffolding of the guides folder that impacts the dropdown presence: instead of having a release/ folder + * that corresponds to the latest version, we have the docs at the root of guides directly. + */ +const unversionPath = (stringContent) => { + return stringContent.replace(/guides\/release/g, 'guides'); +} -// Compare filename in both branches and output a [index].diff +/* + * This function compares the given filename in both branches and output a [index].diff file. + * Example: + * filename = guides/accessibility/index.md, index = 3 + * The diff between ref-upstream and upstream/master for this file is printed in 3.diff + */ const createDiff = (filename, index) => { - const diffName = `scripts/patches/${index}.diff` - if (shell.exec(`git diff ref-upstream upstream/master -- ${filename} > ${diffName}`).code !== 0) { - console.log(`shelljs: "git diff ref-upstream upstream/master -- ${filename} > ${diffName}" command failed`); - process.exit(1); + const diffName = `scripts/patches/${index}.diff`; + try { + runShell(`git diff ref-upstream upstream/master -- ${filename} > ${diffName}`); + return diffName; + } catch (error) { + warnings.push(` +ACTION REQUIRED: The diff file was not created for ${filename}. +-> Check manually if there is a diff to handle between origin/ref-upstream and upstream/master for this file. + +`); + throw new Error(`Failed to create the diff for ${filename}. This was caused by: ${err}`); } - console.log(`shelljs: "git diff ref-upstream upstream/master -- ${filename} > ${diffName}" executed`); - return diffName; } -// Execute all the read/write/unlink operations on diff files -const writeDiffFiles = async (filesToPost) => { - let writePromises = files.map((filename, index) => { - const diffName = createDiff(filename, index); - return new Promise((resolve, reject) => { - // Rewrite the path to adjust it to our Guidemaker scaffolding +/* + * This function executes all the read/write/unlink operations on diff files. + * + * files is the list of files (as path) that changed between ref-upstream and upstream/master + * filesToPost is an empty array of objects { filename, diffName } this function is in charge to fill, + * it will keep track of all the files whose diff can't be applied automatically, and we will reuse it + * to post Github issues. + */ +const writeDiffFiles = async () => { + let writePromises = files.map(async (filename, index) => { + return new Promise((resolve) => { + let diffName; + try { + diffName = createDiff(filename, index); + } catch (error) { + console.error(error); + resolve(1); + } + // Read the created diff file, we need to access its content to adjust it to our Guidemaker scaffolding fs.readFile(diffName, 'utf8', function(err, data) { - if (err) reject(err); - const replacement = data.replace(/guides\/release/g, 'guides'); + if (err) { + warnings.push(` +ACTION REQUIRED: The patch paths could not be edited for ${diffName} because the file couldn't be read. +-> Check what's the issue then edit the path manually: +* Find and replace "guides/release" with "guides" in ${diffName} +* Run "git apply ${diffName}" + If the command is successful, commit the file. + If the command fails, open a GitHub issue and copy the diff using the provided issue template. + +`); + console.error(`Failed to read ${diffName} to edit the patch path. This was caused by: ${err}`); + resolve(1); + } + + // Matching Guidemaker scaffolding consists in replacing path guides/release with guides + const unversionedFileName = unversionPath(filename); + const replacement = unversionPath(data); + fs.writeFile(diffName, replacement, 'utf8', function(err) { - if (err) reject(err); - console.log(`path in ${diffName} updated`); - // Try to apply automatically - if (shell.exec(`git apply ${diffName}`).code !== 0) { - shell.echo(`shelljs: "git apply" command failed for ${diffName}`); - filesToPost.push({filename, diffName}) - } else { + if (err) { + warnings.push(` +ACTION REQUIRED: The patch paths could not be edited for ${diffName} because the file couldn't be edited. +-> Check what's the issue then edit the path manually: + * Find and replace "guides/release" with "guides" in ${diffName} + * Run "git apply ${diffName}" + If the command is successful, commit the file. + If the command fails, open a GitHub issue and copy the diff using the provided issue template. + + `); + console.error(`Failed to write ${diffName} to edit the patch path. This was caused by: ${err}`); + resolve(1); + } + console.log(`Path in ${diffName} updated`); + + // Once diff paths are ready, run "git apply" to patch the markdown file automatically + try { + // Does the current file already exist or is it a new page in the Ember Guides? + let isNew = !fs.existsSync(unversionedFileName); + // git apply runs after we've initialized isNew, because it can create the missing file + runShell(`git apply ${diffName}`); + // If the page is new, git apply works but we still need to push an issue + if (isNew) filesToPost.push({ filename: unversionedFileName }); // Remove the file if the apply was successfull fs.unlink(diffName, function(err) { - if (err) throw err; - console.log(`${diffName} handled and deleted`); + if (err) { + console.error(err); + } else { + console.log(`${diffName} handled and deleted`); + } }); + resolve(0); + } catch (error) { + console.log(`"git apply" command failed for ${diffName}`); + filesToPost.push({ filename: unversionedFileName, diffName }); + resolve(2); } - resolve(); + resolve(0); }); }); }); }); console.log('Ready to create the patch files'); - await Promise.all(writePromises).then(() => { - console.log('All writing operations are done, patch files are applied or stored in scripts/patches/'); + return Promise.all(writePromises).then((result) => { + const hasErrors = result.some((status) => status === 1); + if (hasErrors) { + hasPendingDiff = true; + console.log('Writing operations have been completed with errors. Some of the patch files are applied or stored in scripts/patches/, and manual actions have been added to the warning list.'); + } else { + console.log('All writing operations have been completed without errors, patch files are applied or stored in scripts/patches/'); + } + return result.some((status) => status === 0); }); } -// Post a GitHub issue -const postIssue = (file) => { - const { filename, diffName } = file; - let diffblock = fs.readFileSync(diffName, 'utf8'); - diffblock = diffblock.replaceAll('```', ''); - let shorterName = filename.substring(14); +/* + * This function returns the headers required for all requests to GitHub API. + * It includes both posting issues and opening the catchup PR. + */ +const getRequestHeaders = () => { + return { + 'Accept': 'application/vnd.github+json', + 'Authorization': `token ${token}`, + 'X-GitHub-Api-Version': '2022-11-28' + } +} - return fetch(`https://api.github.com/repos/${repo}/issues`, { - method: 'POST', - headers: { - 'Accept': 'application/vnd.github+json', - 'Authorization': `token ${token}`, - 'X-GitHub-Api-Version': '2022-11-28' - }, - body: JSON.stringify({ - title: `Translate \`${shorterName}\`, Ember ${newEmberVersion}`, - body: ` +/* + * This function generates the body of the Github issues posted by postIssue function. + * Note the diffBlock can be undefined if the file was initially non-existing in origin/ref-upstream branch, + * this case happens when new pages are added to the latest version of the Ember Guides. + */ +const getIssueBody = (filename, diffblock) => { + diffblock = diffblock + ? ` +In the snippet below, you can see what changes were done in the latest English documentation. The purpose of this issue is to adjust the French translation to match the new version: + +\`\`\`diff +${diffblock} +\`\`\` +` + : 'This is the first translation for this file.'; + return ` Please assign yourself to the issue or let a comment at the very moment you start the translation. - + File: \`${filename}\` From Ember: **${currentEmberVersion}** To Ember: **${newEmberVersion}** - -\`\`\`diff + ${diffblock} -\`\`\` - `, - labels: ['Guides FR trad'] - }) - }); +` } -// Try to apply the diff files automatically and keep track of the failed ones -let filesToPost = []; -await writeDiffFiles(filesToPost); -console.log('Files to post on GitHub', filesToPost); - -let issuePostingError = false; +// This function posts a GitHub issue related to the given file +const postIssue = (file) => { + const { filename, diffName } = file; + const shorterName = filename.substring(6); -// Post the diff files content that couldn't be handled automatically to Github -filesToPost.forEach(async (file) => { - try { - console.log(`Attempting to open an issue for ${file.filename}`); - const response = await postIssue(file); - const jsonResponse = await response.json(); - console.log('Server responded with:', jsonResponse); - } catch (error) { - console.log('Issue posting has failed:', error); - issuePostingError = true; + let diffblock; + if (diffName) { + // We need this replacement to not break the body string + diffblock = fs.readFileSync(diffName, 'utf8'); + diffblock = diffblock.replaceAll('```', ''); } - await new Promise(resolve => setTimeout(resolve, 1000)); -}); - -if (!issuePostingError) { - // Once the issues are posted, delete patches folder and files - fs.rmSync('scripts/patches', { recursive: true, force: true }); - console.log('scripts/patches folder and files did their job, deleted'); -} -// If one of the post failed, the files are still here so we can easily open the issue manually - -// Add, commit, push the modifications done automatically so far -if (shell.exec('git add guides').code !== 0) { - console.log('shelljs: "git add guides" command failed'); - process.exit(1); -} -console.log('shelljs: "git add guides" executed'); -if (shell.exec(`git commit -m "feat: automatic catch up from ${currentEmberVersion} to ${newEmberVersion}"`).code !== 0) { - console.log('shelljs: "git commit -m" command failed'); - process.exit(1); -} -console.log('shelljs: "git commit -m" executed'); - -if (shell.exec(`git push origin ${catchupBranch}`).code !== 0) { - console.log(`shelljs: "git push origin ${catchupBranch}" command failed`); - process.exit(1); + return fetch(`https://api.github.com/repos/${repo}/issues`, { + method: 'POST', + headers: getRequestHeaders(), + body: JSON.stringify({ + title: `Translate \`${shorterName}\`, Ember ${newEmberVersion}`, + body: getIssueBody(filename, diffblock), + labels: ['Guides FR trad'] + }) + }); } -console.log(`shelljs: "git push origin ${catchupBranch}" executed`); -// Post the catchup PR -try{ - console.log('Attempting to post the catch up PR'); - const prResponse = await fetch(`https://api.github.com/repos/${repo}/pulls`, { +const openCatchupPR = () => { + return fetch(`https://api.github.com/repos/${repo}/pulls`, { method: 'POST', - headers: { - 'Accept': 'application/vnd.github+json', - 'Authorization': `token ${token}`, - 'X-GitHub-Api-Version': '2022-11-28' - }, + headers: getRequestHeaders(), body: JSON.stringify({ title: `Catch up latest docs: from ${currentEmberVersion} to ${newEmberVersion}`, body: 'This is an automatic catch up PR to align our non-translated documentation with the latest official documentation.', @@ -204,33 +285,228 @@ try{ labels: ['Guides FR trad'] }) }); - const jsonPrResponse = await prResponse.json(); - console.log('Server responded with:', jsonPrResponse); -} catch (error) { - console.log('Catch up PR posting has failed:', error); } -// Replace ref-upstream with current upstream then go back to master -if (shell.exec('git switch ref-upstream').code !== 0) { - console.log('shelljs: "git switch ref-upstream" command failed'); - process.exit(1); +/* + * This function post a GitHub issue for each file that couldn't be patched automatially. + * It works with a classic for loop that pauses the execution during the request and wait one second after the answer is received. + * This is done to control timing and concurrency, as explained in GitHub API documentation. + */ +const postAllIssues = async () => { + for (const file of filesToPost) { + try { + console.log(`Attempting to open an issue for ${file.filename}`); + const response = await postIssue(file); + const jsonResponse = await response.json(); + console.log('Server responded with:', jsonResponse); + } catch (error) { + console.error('Issue posting has failed:', error); + warnings.push(` +ACTION REQUIRED: The issue for file ${file.filename} (${file.diffName}) couldn't be opened automatically. +-> Open it manually using the dedicated issue template. + +`); + issuePostingError = true; + } finally { + await new Promise(resolve => setTimeout(resolve, 1000)); + } + }; + + // If one of the post failed, we keep the diff files so we can easily open the issue manually + if (issuePostingError) { + console.error("At least one Github issue was not posted, scripts/patches folder won't be deleted so missing issues can be posted manually"); + } else { + try { + // If and once the issues are posted, delete patches folder and files + fs.rmSync('scripts/patches', { recursive: true, force: true }); + console.log('scripts/patches folder and files did their job, deleted'); + } catch(error) { + console.error('Failed to delete the folder scripts/patches and its content.') + } + } +} + +/* + * This function adds, commits, and pushes the modifications in "guides" folder + */ +const pushChanges = () => { + try { + runShell('git add guides'); + runShell(`git commit -m "feat: automatic catch up from ${currentEmberVersion} to ${newEmberVersion}"`); + runShell(`git push origin ${catchupBranch}`); + } catch (error) { + warnings.push(` +ACTION REQUIRED: Failed to push the catchup branch +-> Check what's the issue, then push the changes and open the Github PR manually. + +`); + throw error; + } } -console.log('shelljs: "git switch ref-upstream" executed'); -if (shell.exec('git reset --hard upstream/master').code !== 0) { - console.log('shelljs: "git reset --hard upstream/master" command failed'); - process.exit(1); +/* + * This function performs a switch to the master branch. + * The error message highlights the fact this is perform at the end of the process, + * to warn the developer that despite this last error, the process is completed. + */ +const switchToMaster = () => { + try { + runShell('git switch master'); + } catch (error) { + console.error('The process is complete, but failed to switch back to master'); + } } -console.log('shelljs: "git reset --hard upstream/master" executed'); -if (shell.exec('git push origin -f ref-upstream').code !== 0) { - console.log('shelljs: "git push origin -f ref-upstream" command failed'); - process.exit(1); +/* + * This function performs a switch to the catchup branch. + * The success message highlights the fact this is perform at the end of the process, + * to exit on the catchup branch so post failures can be easily handled manually. + */ +const switchToCatchup = () => { + try { + runShell(`git switch ${catchupBranch}`); + console.log('Stay on the catchup branch at the end of the process, so non-posted issues can be handled.'); + } catch (error) { + console.error(`The process is complete, but failed to switch back to ${catchupBranch}`); + warnings.push(` +ACTION REQUIRED: The process failed to switch back to ${catchupBranch}. +-> Switch manually to ${catchupBranch} then complete the other required actions. + + `); + } } -console.log('shelljs: "git push origin -f ref-upstream" executed'); -if (shell.exec('git switch master').code !== 0) { - console.log('shelljs: "git switch master" command failed'); - process.exit(1); +/* + * This function switches to the ref-upstream branch to reset it to the latest upstream/master, + * then it pushes ref-upstream branch to the origin repository. + */ +const updateRefUpstream = () => { + try { + runShell('git switch ref-upstream'); + runShell('git reset --hard upstream/master'); + runShell('git push origin -f ref-upstream'); + } catch (error) { + warnings.push(` +ACTION REQUIRED: The process failed to reset ref-upstream to the latest upstream/master. +-> Perform manually: +* git switch ref-upstream +* git reset --hard upstream/master +* git push origin -f ref-upstream + `); + throw new Error('Failed to reset ref-upstream to the latest upstream/master'); + } } -console.log('shelljs: "git switch master" executed'); \ No newline at end of file + +/* + * This function performs the last actions once most of the catchup is done + * It updates ref-upstream to upstream/master if there's no pending manual action, + * then it switches back to master. + */ +const closeProcess = () => { + if (hasPendingDiff) { + warnings.push(` +ACTION REQUIRED: To manage some of the warnings above, you might need to use ref-upstream in its current state, so it was not updated. +-> Once you are done with everything above, run: + * git switch ref-upstream + * git reset --hard upstream/master + * git push origin -f ref-upstream + + `); + } + else { + try { + /* Reset ref-upstream to the current upstream/master to get ready for the next catchup + * ref-upstream should always match the version under translation */ + updateRefUpstream(); + + /* Then go back to master only if there's no diff file to post manually. + * If there are diff files to post manually, then it's more convinient to stay on the catchup branch */ + if (!issuePostingError) { + switchToMaster(); + } else { + switchToCatchup(); + } + } catch(error) { + throw error; + } + } +} + +try { + + try { + // Create a catchup branch out of the current branch (should be up to date master) + runShell(`git switch --create ${catchupBranch}`); + // Fetch the latest ref-upstream branch (English version under translation on this repo) + runShell('git fetch'); + // Fetch the latest updates in the official Ember Guides + runShell('git fetch upstream'); + // Output the list of markdown files impacted by latest changes on upstream + runShell('git diff --name-only origin/ref-upstream upstream/master -- guides/release > list.diff'); + } catch (error) { + throw new Error('Failed to create the diff between origin/ref-upstream and upstream/master in a new branch. The catchup cannot continue.'); + } + + // Read list.diff to extract the list of path to markdown files + let data = fs.readFileSync('list.diff', 'utf8'); + files = data.split(/[\n\r]/).filter(name => name.length); + fs.unlink('list.diff', function(err) { + if (err) { + console.error('Failed to delete list.diff'); + } else { + console.log('list.diff did its job, deleted'); + } + }); + + // If there's no diff in the guides part, we can stop here + if (files && files.length > 0) { + + // Create a directory to put the children diff + fs.mkdirSync('scripts/patches', { recursive: true }); + console.log('scripts/patches folder created to store the patch files'); + + /* Try to apply the diff files automatically and keep track of the failed and new ones. + * hasAutoApply is true if at least one file could be patched automatically. */ + let hasAutoApply = await writeDiffFiles(); + console.log('Files to post on GitHub:', filesToPost); + + /* Post Github issues for diff files that couldn't be handled automatically + * we await so the POST for issues and the POST for the catchup PR below are not done at the same time */ + await postAllIssues(); + + // Post the catchup PR if there's at least one patched file to commit + if (hasAutoApply) { + try { + pushChanges(); + + try { + console.log('Attempting to post the catch up PR'); + const prResponse = await openCatchupPR(); + const jsonPrResponse = await prResponse.json(); + console.log('Server responded with:', jsonPrResponse); + } catch (error) { + console.error(`Failed to post the catchup PR. This was caused by: ${error}`); + warnings.push(` +ACTION REQUIRED: The catchup PR was not opened automatically on GitHub. +-> Chack what's the issue, then open the PR on GitHub manually. + + `); + } + + } catch (error) { + console.error('Failed to push the catchup branch.'); + } + } + + } else { + console.log('No change between both versions of the Ember Guides.'); + } + + closeProcess(); + printWarningMessages(); + +} catch (error) { + console.error(error); + printWarningMessages(); + process.exitCode = 1; +} \ No newline at end of file