|
| 1 | +// Licensed to the .NET Foundation under one or more agreements. |
| 2 | +// The .NET Foundation licenses this file to you under the MIT license. |
| 3 | + |
| 4 | +function BackportException(message, postToGitHub = true) { |
| 5 | + this.message = message; |
| 6 | + this.postToGitHub = postToGitHub; |
| 7 | +} |
| 8 | + |
| 9 | +async function run() { |
| 10 | + const util = require("util"); |
| 11 | + const jsExec = util.promisify(require("child_process").exec); |
| 12 | + |
| 13 | + console.log("Installing npm dependencies"); |
| 14 | + const { stdout, stderr } = await jsExec("npm install @actions/core @actions/github @actions/exec"); |
| 15 | + console.log("npm-install stderr:\n\n" + stderr); |
| 16 | + console.log("npm-install stdout:\n\n" + stdout); |
| 17 | + console.log("Finished installing npm dependencies"); |
| 18 | + |
| 19 | + const core = require("@actions/core"); |
| 20 | + const github = require("@actions/github"); |
| 21 | + const exec = require("@actions/exec"); |
| 22 | + |
| 23 | + const repo_owner = github.context.payload.repository.owner.login; |
| 24 | + const repo_name = github.context.payload.repository.name; |
| 25 | + const pr_number = github.context.payload.issue.number; |
| 26 | + const comment_user = github.context.payload.comment.user.login; |
| 27 | + |
| 28 | + let octokit = github.getOctokit(core.getInput("auth_token", { required: true })); |
| 29 | + let target_branch = core.getInput("target_branch", { required: true }); |
| 30 | + |
| 31 | + try { |
| 32 | + // verify the comment user is a repo collaborator |
| 33 | + try { |
| 34 | + await octokit.rest.repos.checkCollaborator({ |
| 35 | + owner: repo_owner, |
| 36 | + repo: repo_name, |
| 37 | + username: comment_user |
| 38 | + }); |
| 39 | + console.log(`Verified ${comment_user} is a repo collaborator.`); |
| 40 | + } catch (error) { |
| 41 | + console.log(error); |
| 42 | + throw new BackportException(`Error: @${comment_user} is not a repo collaborator, backporting is not allowed. If you're a collaborator please make sure your ${repo_owner} team membership visibility is set to Public on https://github.com/orgs/${repo_owner}/people?query=${comment_user}`); |
| 43 | + } |
| 44 | + |
| 45 | + try { await exec.exec(`git ls-remote --exit-code --heads origin ${target_branch}`) } catch { throw new BackportException(`Error: The specified backport target branch ${target_branch} wasn't found in the repo.`); } |
| 46 | + console.log(`Backport target branch: ${target_branch}`); |
| 47 | + |
| 48 | + console.log("Applying backport patch"); |
| 49 | + |
| 50 | + await exec.exec(`git checkout ${target_branch}`); |
| 51 | + await exec.exec(`git clean -xdff`); |
| 52 | + |
| 53 | + // configure git |
| 54 | + await exec.exec(`git config user.name "github-actions"`); |
| 55 | + await exec.exec(`git config user.email "github-actions@github.com"`); |
| 56 | + |
| 57 | + // create temporary backport branch |
| 58 | + const temp_branch = `backport/pr-${pr_number}-to-${target_branch}`; |
| 59 | + await exec.exec(`git checkout -b ${temp_branch}`); |
| 60 | + |
| 61 | + // skip opening PR if the branch already exists on the origin remote since that means it was opened |
| 62 | + // by an earlier backport and force pushing to the branch updates the existing PR |
| 63 | + let should_open_pull_request = true; |
| 64 | + try { |
| 65 | + await exec.exec(`git ls-remote --exit-code --heads origin ${temp_branch}`); |
| 66 | + should_open_pull_request = false; |
| 67 | + } catch { } |
| 68 | + |
| 69 | + // download and apply patch |
| 70 | + await exec.exec(`curl -sSL "${github.context.payload.issue.pull_request.patch_url}" --output changes.patch`); |
| 71 | + |
| 72 | + const git_am_command = "git am --3way --ignore-whitespace --keep-non-patch changes.patch"; |
| 73 | + let git_am_output = `$ ${git_am_command}\n\n`; |
| 74 | + let git_am_failed = false; |
| 75 | + try { |
| 76 | + await exec.exec(git_am_command, [], { |
| 77 | + listeners: { |
| 78 | + stdout: function stdout(data) { git_am_output += data; }, |
| 79 | + stderr: function stderr(data) { git_am_output += data; } |
| 80 | + } |
| 81 | + }); |
| 82 | + } catch (error) { |
| 83 | + git_am_output += error; |
| 84 | + git_am_failed = true; |
| 85 | + } |
| 86 | + |
| 87 | + if (git_am_failed) { |
| 88 | + const git_am_failed_body = `@${github.context.payload.comment.user.login} backporting to ${target_branch} failed, the patch most likely resulted in conflicts:\n\n\`\`\`shell\n${git_am_output}\n\`\`\`\n\nPlease backport manually!`; |
| 89 | + await octokit.rest.issues.createComment({ |
| 90 | + owner: repo_owner, |
| 91 | + repo: repo_name, |
| 92 | + issue_number: pr_number, |
| 93 | + body: git_am_failed_body |
| 94 | + }); |
| 95 | + throw new BackportException("Error: git am failed, most likely due to a merge conflict.", false); |
| 96 | + } |
| 97 | + else { |
| 98 | + // push the temp branch to the repository |
| 99 | + await exec.exec(`git push --force --set-upstream origin HEAD:${temp_branch}`); |
| 100 | + } |
| 101 | + |
| 102 | + if (!should_open_pull_request) { |
| 103 | + console.log("Backport temp branch already exists, skipping opening a PR."); |
| 104 | + return; |
| 105 | + } |
| 106 | + |
| 107 | + // prepate the GitHub PR details |
| 108 | + let backport_pr_title = core.getInput("pr_title_template"); |
| 109 | + let backport_pr_description = core.getInput("pr_description_template"); |
| 110 | + |
| 111 | + // get users to cc (append PR author if different from user who issued the backport command) |
| 112 | + let cc_users = `@${comment_user}`; |
| 113 | + if (comment_user != github.context.payload.issue.user.login) cc_users += ` @${github.context.payload.issue.user.login}`; |
| 114 | + |
| 115 | + // replace the special placeholder tokens with values |
| 116 | + backport_pr_title = backport_pr_title |
| 117 | + .replace(/%target_branch%/g, target_branch) |
| 118 | + .replace(/%source_pr_title%/g, github.context.payload.issue.title) |
| 119 | + .replace(/%source_pr_number%/g, github.context.payload.issue.number) |
| 120 | + .replace(/%cc_users%/g, cc_users); |
| 121 | + |
| 122 | + backport_pr_description = backport_pr_description |
| 123 | + .replace(/%target_branch%/g, target_branch) |
| 124 | + .replace(/%source_pr_title%/g, github.context.payload.issue.title) |
| 125 | + .replace(/%source_pr_number%/g, github.context.payload.issue.number) |
| 126 | + .replace(/%cc_users%/g, cc_users); |
| 127 | + |
| 128 | + // open the GitHub PR |
| 129 | + await octokit.rest.pulls.create({ |
| 130 | + owner: repo_owner, |
| 131 | + repo: repo_name, |
| 132 | + title: backport_pr_title, |
| 133 | + body: backport_pr_description, |
| 134 | + head: temp_branch, |
| 135 | + base: target_branch |
| 136 | + }); |
| 137 | + |
| 138 | + console.log("Successfully opened the GitHub PR."); |
| 139 | + } catch (error) { |
| 140 | + |
| 141 | + core.setFailed(error); |
| 142 | + |
| 143 | + if (error.postToGitHub === undefined || error.postToGitHub == true) { |
| 144 | + // post failure to GitHub comment |
| 145 | + const unknown_error_body = `@${comment_user} an error occurred while backporting to ${target_branch}, please check the run log for details!\n\n${error.message}`; |
| 146 | + await octokit.rest.issues.createComment({ |
| 147 | + owner: repo_owner, |
| 148 | + repo: repo_name, |
| 149 | + issue_number: pr_number, |
| 150 | + body: unknown_error_body |
| 151 | + }); |
| 152 | + } |
| 153 | + } |
| 154 | +} |
| 155 | + |
| 156 | +run(); |
0 commit comments