ARROW-5716: [Developer] Improve merge PR script to attribute multiple authors#4882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wesm wants to merge 5 commits into from
Closed

ARROW-5716: [Developer] Improve merge PR script to attribute multiple authors #4882

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7924dab
Add support for lead/co-authors to merge script
wesm Jul 15, 2019
0ebc17e
Add debugging output
wesm Jul 15, 2019
6d65ceb
Fix DEBUG env variable flag logic [skip ci]
wesm Jul 15, 2019
74fb732
Put authors at end of commit message so GitHub understands them [skip…
wesm Jul 17, 2019
816a137
Do not prompt for lead author if there is only one person involved [s…
wesm Jul 17, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 60 additions & 16 deletions dev/merge_arrow_pr.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,8 @@
# There are several pieces of authorization possibly needed via environment
# variables
#
# JIRA_USERNAME: your Apache JIRA id
# JIRA_PASSWORD: your Apache JIRA password
# APACHE_JIRA_USERNAME: your Apache JIRA id
# APACHE_JIRA_PASSWORD: your Apache JIRA password
# ARROW_GITHUB_API_TOKEN: a GitHub API token to use for API requests (to avoid
# rate limiting)

Expand All@@ -52,6 +52,16 @@
print("Exiting without trying to close the associated JIRA.")
sys.exit(1)

# Remote name which points to the GitHub site
PR_REMOTE_NAME = os.environ.get("PR_REMOTE_NAME", "apache")

# For testing to avoid accidentally pushing to apache
DEBUG = bool(int(os.environ.get("DEBUG", 0)))


if DEBUG:
print("**************** DEBUGGING ****************")


# Prefix added to temporary branches
BRANCH_PREFIX = "PR_TOOL"
Expand DownExpand Up@@ -339,7 +349,27 @@ def merge(self, target_ref='master'):
distinct_authors = sorted(set(commit_authors),
key=lambda x: commit_authors.count(x),
reverse=True)
primary_author = distinct_authors[0]

for i, author in enumerate(distinct_authors):
print("Author {}: {}".format(i + 1, author))

if len(distinct_authors) > 1:
primary_author = self.cmd.prompt(
"Enter primary author in the format of "
"\"name <email>\" [%s]: " % distinct_authors[0])

if primary_author == "":
primary_author = distinct_authors[0]
else:
# When primary author is specified manually, de-dup it from
# author list and put it at the head of author list.
distinct_authors = [x for x in distinct_authors
if x != primary_author]
distinct_authors = [primary_author] + distinct_authors
else:
# If there is only one author, do not prompt for a lead author
primary_author = distinct_authors[0]

commits = run_cmd(['git', 'log', 'HEAD..%s' % pr_branch_name,
'--pretty=format:%h <%an> %s']).split("\n\n")

Expand All@@ -349,9 +379,17 @@ def merge(self, target_ref='master'):
if self.body is not None:
merge_message_flags += ["-m", self.body]

authors = "\n".join(["Author: %s" % a for a in distinct_authors])
committer_name = run_cmd("git config --get user.name").strip()
committer_email = run_cmd("git config --get user.email").strip()

merge_message_flags += ["-m", authors]
authors = ("Authored-by:" if len(distinct_authors) == 1
else "Lead-authored-by:")
authors += " %s" % (distinct_authors.pop(0))
if len(distinct_authors) > 0:
authors += "\n" + "\n".join(["Co-authored-by: %s" % a
for a in distinct_authors])
authors += "\n" + "Signed-off-by: %s <%s>" % (committer_name,
committer_email)

if had_conflicts:
committer_name = run_cmd("git config --get user.name").strip()
Expand All@@ -371,6 +409,11 @@ def merge(self, target_ref='master'):
stripped_message = strip_ci_directives(c).strip()
merge_message_flags += ["-m", stripped_message]

merge_message_flags += ["-m", authors]

if DEBUG:
print("\n".join(merge_message_flags))

run_cmd(['git', 'commit',
'--no-verify', # do not run commit hooks
'--author="%s"' % primary_author] +
Expand All@@ -380,9 +423,13 @@ def merge(self, target_ref='master'):
% (target_branch_name, self.git_remote))

try:
run_cmd('git push %s %s:%s' % (self.git_remote,
target_branch_name,
target_ref))
push_cmd = ('git push %s %s:%s' % (self.git_remote,
target_branch_name,
target_ref))
if DEBUG:
print(push_cmd)
else:
run_cmd(push_cmd)
except Exception as e:
clean_up()
self.cmd.fail("Exception while pushing: %s" % e)
Expand DownExpand Up@@ -415,17 +462,17 @@ def get_version_json(version_str):

def connect_jira(cmd):
# ASF JIRA username
jira_username = os.environ.get("JIRA_USERNAME")
jira_username = os.environ.get("APACHE_JIRA_USERNAME")

# ASF JIRA password
jira_password = os.environ.get("JIRA_PASSWORD")
jira_password = os.environ.get("APACHE_JIRA_PASSWORD")

if not jira_username:
jira_username = cmd.prompt("Env JIRA_USERNAME not set, "
jira_username = cmd.prompt("Env APACHE_JIRA_USERNAME not set, "
"please enter your JIRA username:")

if not jira_password:
jira_password = cmd.getpass("Env JIRA_PASSWORD not set, "
jira_password = cmd.getpass("Env APACHE_JIRA_PASSWORD not set, "
"please enter "
"your JIRA password:")

Expand All@@ -444,15 +491,12 @@ def cli():

pr_num = input("Which pull request would you like to merge? (e.g. 34): ")

# Remote name which points to the GitHub site
git_remote = os.environ.get("PR_REMOTE_NAME", "apache")

os.chdir(ARROW_HOME)

github_api = GitHubAPI(PROJECT_NAME)

jira_con = connect_jira(cmd)
pr = PullRequest(cmd, github_api, git_remote, jira_con, pr_num)
pr = PullRequest(cmd, github_api, PR_REMOTE_NAME, jira_con, pr_num)

if pr.is_merged:
print("Pull request %s has already been merged")
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
ARROW-5716: [Developer] Improve merge PR script to attribute multiple authors#4882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

wesm
wants to merge
5
commits into

from

 Closed


ARROW-5716: [Developer] Improve merge PR script to attribute multiple authors
#4882
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
7924dab

Add support for lead/co-authors to merge script


wesm Jul 15, 2019
0ebc17e

Add debugging output


wesm Jul 15, 2019
6d65ceb

Fix DEBUG env variable flag logic [skip ci]


wesm Jul 15, 2019
74fb732

Put authors at end of commit message so GitHub understands them [skip…


wesm Jul 17, 2019
816a137

Do not prompt for lead author if there is only one person involved [s…


wesm Jul 17, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


76 changes: 60 additions & 16 deletions
dev/merge_arrow_pr.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,8 @@
# There are several pieces of authorization possibly needed via environment
# variables
#
# JIRA_USERNAME: your Apache JIRA id
# JIRA_PASSWORD: your Apache JIRA password
# APACHE_JIRA_USERNAME: your Apache JIRA id
# APACHE_JIRA_PASSWORD: your Apache JIRA password
# ARROW_GITHUB_API_TOKEN: a GitHub API token to use for API requests (to avoid
# rate limiting)

Expand All@@ -52,6 +52,16 @@
 print("Exiting without trying to close the associated JIRA.")
 sys.exit(1)

# Remote name which points to the GitHub site
PR_REMOTE_NAME = os.environ.get("PR_REMOTE_NAME", "apache")

# For testing to avoid accidentally pushing to apache
DEBUG = bool(int(os.environ.get("DEBUG", 0)))


if DEBUG:
 print("**************** DEBUGGING ****************")


# Prefix added to temporary branches
BRANCH_PREFIX = "PR_TOOL"
Expand DownExpand Up@@ -339,7 +349,27 @@ def merge(self, target_ref='master'):
 distinct_authors = sorted(set(commit_authors),
 key=lambda x: commit_authors.count(x),
 reverse=True)
 primary_author = distinct_authors[0]

 for i, author in enumerate(distinct_authors):
 print("Author {}: {}".format(i + 1, author))

 if len(distinct_authors) > 1:
 primary_author = self.cmd.prompt(
 "Enter primary author in the format of "
 "\"name <email>\" [%s]: " % distinct_authors[0])

 if primary_author == "":
 primary_author = distinct_authors[0]
 else:
 # When primary author is specified manually, de-dup it from
 # author list and put it at the head of author list.
 distinct_authors = [x for x in distinct_authors
 if x != primary_author]
 distinct_authors = [primary_author] + distinct_authors
 else:
 # If there is only one author, do not prompt for a lead author
 primary_author = distinct_authors[0]

 commits = run_cmd(['git', 'log', 'HEAD..%s' % pr_branch_name,
 '--pretty=format:%h <%an> %s']).split("\n\n")

Expand All@@ -349,9 +379,17 @@ def merge(self, target_ref='master'):
 if self.body is not None:
 merge_message_flags += ["-m", self.body]

 authors = "\n".join(["Author: %s" % a for a in distinct_authors])
 committer_name = run_cmd("git config --get user.name").strip()
 committer_email = run_cmd("git config --get user.email").strip()

 merge_message_flags += ["-m", authors]
 authors = ("Authored-by:" if len(distinct_authors) == 1
 else "Lead-authored-by:")
 authors += " %s" % (distinct_authors.pop(0))
 if len(distinct_authors) > 0:
 authors += "\n" + "\n".join(["Co-authored-by: %s" % a
 for a in distinct_authors])
 authors += "\n" + "Signed-off-by: %s <%s>" % (committer_name,
 committer_email)

 if had_conflicts:
 committer_name = run_cmd("git config --get user.name").strip()
Expand All@@ -371,6 +409,11 @@ def merge(self, target_ref='master'):
 stripped_message = strip_ci_directives(c).strip()
 merge_message_flags += ["-m", stripped_message]

 merge_message_flags += ["-m", authors]

 if DEBUG:
 print("\n".join(merge_message_flags))

 run_cmd(['git', 'commit',
 '--no-verify', # do not run commit hooks
 '--author="%s"' % primary_author] +
Expand All@@ -380,9 +423,13 @@ def merge(self, target_ref='master'):
 % (target_branch_name, self.git_remote))

 try:
 run_cmd('git push %s %s:%s' % (self.git_remote,
 target_branch_name,
 target_ref))
 push_cmd = ('git push %s %s:%s' % (self.git_remote,
 target_branch_name,
 target_ref))
 if DEBUG:
 print(push_cmd)
 else:
 run_cmd(push_cmd)
 except Exception as e:
 clean_up()
 self.cmd.fail("Exception while pushing: %s" % e)
Expand DownExpand Up@@ -415,17 +462,17 @@ def get_version_json(version_str):

def connect_jira(cmd):
 # ASF JIRA username
 jira_username = os.environ.get("JIRA_USERNAME")
 jira_username = os.environ.get("APACHE_JIRA_USERNAME")

 # ASF JIRA password
 jira_password = os.environ.get("JIRA_PASSWORD")
 jira_password = os.environ.get("APACHE_JIRA_PASSWORD")

 if not jira_username:
 jira_username = cmd.prompt("Env JIRA_USERNAME not set, "
 jira_username = cmd.prompt("Env APACHE_JIRA_USERNAME not set, "
 "please enter your JIRA username:")

 if not jira_password:
 jira_password = cmd.getpass("Env JIRA_PASSWORD not set, "
 jira_password = cmd.getpass("Env APACHE_JIRA_PASSWORD not set, "
 "please enter "
 "your JIRA password:")

Expand All@@ -444,15 +491,12 @@ def cli():

 pr_num = input("Which pull request would you like to merge? (e.g. 34): ")

 # Remote name which points to the GitHub site
 git_remote = os.environ.get("PR_REMOTE_NAME", "apache")

 os.chdir(ARROW_HOME)

 github_api = GitHubAPI(PROJECT_NAME)

 jira_con = connect_jira(cmd)
 pr = PullRequest(cmd, github_api, git_remote, jira_con, pr_num)
 pr = PullRequest(cmd, github_api, PR_REMOTE_NAME, jira_con, pr_num)

 if pr.is_merged:
 print("Pull request %s has already been merged")
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ARROW-5716: [Developer] Improve merge PR script to attribute multiple authors#4882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

wesm
wants to merge
5
commits into

from

 Closed


ARROW-5716: [Developer] Improve merge PR script to attribute multiple authors
#4882
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
7924dab

Add support for lead/co-authors to merge script


wesm Jul 15, 2019
0ebc17e

Add debugging output


wesm Jul 15, 2019
6d65ceb

Fix DEBUG env variable flag logic [skip ci]


wesm Jul 15, 2019
74fb732

Put authors at end of commit message so GitHub understands them [skip…


wesm Jul 17, 2019
816a137

Do not prompt for lead author if there is only one person involved [s…


wesm Jul 17, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


76 changes: 60 additions & 16 deletions
dev/merge_arrow_pr.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,8 @@
# There are several pieces of authorization possibly needed via environment
# variables
#
# JIRA_USERNAME: your Apache JIRA id
# JIRA_PASSWORD: your Apache JIRA password
# APACHE_JIRA_USERNAME: your Apache JIRA id
# APACHE_JIRA_PASSWORD: your Apache JIRA password
# ARROW_GITHUB_API_TOKEN: a GitHub API token to use for API requests (to avoid
# rate limiting)

Expand All@@ -52,6 +52,16 @@
 print("Exiting without trying to close the associated JIRA.")
 sys.exit(1)

# Remote name which points to the GitHub site
PR_REMOTE_NAME = os.environ.get("PR_REMOTE_NAME", "apache")

# For testing to avoid accidentally pushing to apache
DEBUG = bool(int(os.environ.get("DEBUG", 0)))


if DEBUG:
 print("**************** DEBUGGING ****************")


# Prefix added to temporary branches
BRANCH_PREFIX = "PR_TOOL"
Expand DownExpand Up@@ -339,7 +349,27 @@ def merge(self, target_ref='master'):
 distinct_authors = sorted(set(commit_authors),
 key=lambda x: commit_authors.count(x),
 reverse=True)
 primary_author = distinct_authors[0]

 for i, author in enumerate(distinct_authors):
 print("Author {}: {}".format(i + 1, author))

 if len(distinct_authors) > 1:
 primary_author = self.cmd.prompt(
 "Enter primary author in the format of "
 "\"name <email>\" [%s]: " % distinct_authors[0])

 if primary_author == "":
 primary_author = distinct_authors[0]
 else:
 # When primary author is specified manually, de-dup it from
 # author list and put it at the head of author list.
 distinct_authors = [x for x in distinct_authors
 if x != primary_author]
 distinct_authors = [primary_author] + distinct_authors
 else:
 # If there is only one author, do not prompt for a lead author
 primary_author = distinct_authors[0]

 commits = run_cmd(['git', 'log', 'HEAD..%s' % pr_branch_name,
 '--pretty=format:%h <%an> %s']).split("\n\n")

Expand All@@ -349,9 +379,17 @@ def merge(self, target_ref='master'):
 if self.body is not None:
 merge_message_flags += ["-m", self.body]

 authors = "\n".join(["Author: %s" % a for a in distinct_authors])
 committer_name = run_cmd("git config --get user.name").strip()
 committer_email = run_cmd("git config --get user.email").strip()

 merge_message_flags += ["-m", authors]
 authors = ("Authored-by:" if len(distinct_authors) == 1
 else "Lead-authored-by:")
 authors += " %s" % (distinct_authors.pop(0))
 if len(distinct_authors) > 0:
 authors += "\n" + "\n".join(["Co-authored-by: %s" % a
 for a in distinct_authors])
 authors += "\n" + "Signed-off-by: %s <%s>" % (committer_name,
 committer_email)

 if had_conflicts:
 committer_name = run_cmd("git config --get user.name").strip()
Expand All@@ -371,6 +409,11 @@ def merge(self, target_ref='master'):
 stripped_message = strip_ci_directives(c).strip()
 merge_message_flags += ["-m", stripped_message]

 merge_message_flags += ["-m", authors]

 if DEBUG:
 print("\n".join(merge_message_flags))

 run_cmd(['git', 'commit',
 '--no-verify', # do not run commit hooks
 '--author="%s"' % primary_author] +
Expand All@@ -380,9 +423,13 @@ def merge(self, target_ref='master'):
 % (target_branch_name, self.git_remote))

 try:
 run_cmd('git push %s %s:%s' % (self.git_remote,
 target_branch_name,
 target_ref))
 push_cmd = ('git push %s %s:%s' % (self.git_remote,
 target_branch_name,
 target_ref))
 if DEBUG:
 print(push_cmd)
 else:
 run_cmd(push_cmd)
 except Exception as e:
 clean_up()
 self.cmd.fail("Exception while pushing: %s" % e)
Expand DownExpand Up@@ -415,17 +462,17 @@ def get_version_json(version_str):

def connect_jira(cmd):
 # ASF JIRA username
 jira_username = os.environ.get("JIRA_USERNAME")
 jira_username = os.environ.get("APACHE_JIRA_USERNAME")

 # ASF JIRA password
 jira_password = os.environ.get("JIRA_PASSWORD")
 jira_password = os.environ.get("APACHE_JIRA_PASSWORD")

 if not jira_username:
 jira_username = cmd.prompt("Env JIRA_USERNAME not set, "
 jira_username = cmd.prompt("Env APACHE_JIRA_USERNAME not set, "
 "please enter your JIRA username:")

 if not jira_password:
 jira_password = cmd.getpass("Env JIRA_PASSWORD not set, "
 jira_password = cmd.getpass("Env APACHE_JIRA_PASSWORD not set, "
 "please enter "
 "your JIRA password:")

Expand All@@ -444,15 +491,12 @@ def cli():

 pr_num = input("Which pull request would you like to merge? (e.g. 34): ")

 # Remote name which points to the GitHub site
 git_remote = os.environ.get("PR_REMOTE_NAME", "apache")

 os.chdir(ARROW_HOME)

 github_api = GitHubAPI(PROJECT_NAME)

 jira_con = connect_jira(cmd)
 pr = PullRequest(cmd, github_api, git_remote, jira_con, pr_num)
 pr = PullRequest(cmd, github_api, PR_REMOTE_NAME, jira_con, pr_num)

 if pr.is_merged:
 print("Pull request %s has already been merged")
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ARROW-5716: [Developer] Improve merge PR script to attribute multiple authors#4882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

wesm
wants to merge
5
commits into

from

 Closed


ARROW-5716: [Developer] Improve merge PR script to attribute multiple authors
#4882
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
7924dab

Add support for lead/co-authors to merge script


wesm Jul 15, 2019
0ebc17e

Add debugging output


wesm Jul 15, 2019
6d65ceb

Fix DEBUG env variable flag logic [skip ci]


wesm Jul 15, 2019
74fb732

Put authors at end of commit message so GitHub understands them [skip…


wesm Jul 17, 2019
816a137

Do not prompt for lead author if there is only one person involved [s…


wesm Jul 17, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


76 changes: 60 additions & 16 deletions
dev/merge_arrow_pr.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,8 @@
# There are several pieces of authorization possibly needed via environment
# variables
#
# JIRA_USERNAME: your Apache JIRA id
# JIRA_PASSWORD: your Apache JIRA password
# APACHE_JIRA_USERNAME: your Apache JIRA id
# APACHE_JIRA_PASSWORD: your Apache JIRA password
# ARROW_GITHUB_API_TOKEN: a GitHub API token to use for API requests (to avoid
# rate limiting)

Expand All@@ -52,6 +52,16 @@
 print("Exiting without trying to close the associated JIRA.")
 sys.exit(1)

# Remote name which points to the GitHub site
PR_REMOTE_NAME = os.environ.get("PR_REMOTE_NAME", "apache")

# For testing to avoid accidentally pushing to apache
DEBUG = bool(int(os.environ.get("DEBUG", 0)))


if DEBUG:
 print("**************** DEBUGGING ****************")


# Prefix added to temporary branches
BRANCH_PREFIX = "PR_TOOL"
Expand DownExpand Up@@ -339,7 +349,27 @@ def merge(self, target_ref='master'):
 distinct_authors = sorted(set(commit_authors),
 key=lambda x: commit_authors.count(x),
 reverse=True)
 primary_author = distinct_authors[0]

 for i, author in enumerate(distinct_authors):
 print("Author {}: {}".format(i + 1, author))

 if len(distinct_authors) > 1:
 primary_author = self.cmd.prompt(
 "Enter primary author in the format of "
 "\"name <email>\" [%s]: " % distinct_authors[0])

 if primary_author == "":
 primary_author = distinct_authors[0]
 else:
 # When primary author is specified manually, de-dup it from
 # author list and put it at the head of author list.
 distinct_authors = [x for x in distinct_authors
 if x != primary_author]
 distinct_authors = [primary_author] + distinct_authors
 else:
 # If there is only one author, do not prompt for a lead author
 primary_author = distinct_authors[0]

 commits = run_cmd(['git', 'log', 'HEAD..%s' % pr_branch_name,
 '--pretty=format:%h <%an> %s']).split("\n\n")

Expand All@@ -349,9 +379,17 @@ def merge(self, target_ref='master'):
 if self.body is not None:
 merge_message_flags += ["-m", self.body]

 authors = "\n".join(["Author: %s" % a for a in distinct_authors])
 committer_name = run_cmd("git config --get user.name").strip()
 committer_email = run_cmd("git config --get user.email").strip()

 merge_message_flags += ["-m", authors]
 authors = ("Authored-by:" if len(distinct_authors) == 1
 else "Lead-authored-by:")
 authors += " %s" % (distinct_authors.pop(0))
 if len(distinct_authors) > 0:
 authors += "\n" + "\n".join(["Co-authored-by: %s" % a
 for a in distinct_authors])
 authors += "\n" + "Signed-off-by: %s <%s>" % (committer_name,
 committer_email)

 if had_conflicts:
 committer_name = run_cmd("git config --get user.name").strip()
Expand All@@ -371,6 +409,11 @@ def merge(self, target_ref='master'):
 stripped_message = strip_ci_directives(c).strip()
 merge_message_flags += ["-m", stripped_message]

 merge_message_flags += ["-m", authors]

 if DEBUG:
 print("\n".join(merge_message_flags))

 run_cmd(['git', 'commit',
 '--no-verify', # do not run commit hooks
 '--author="%s"' % primary_author] +
Expand All@@ -380,9 +423,13 @@ def merge(self, target_ref='master'):
 % (target_branch_name, self.git_remote))

 try:
 run_cmd('git push %s %s:%s' % (self.git_remote,
 target_branch_name,
 target_ref))
 push_cmd = ('git push %s %s:%s' % (self.git_remote,
 target_branch_name,
 target_ref))
 if DEBUG:
 print(push_cmd)
 else:
 run_cmd(push_cmd)
 except Exception as e:
 clean_up()
 self.cmd.fail("Exception while pushing: %s" % e)
Expand DownExpand Up@@ -415,17 +462,17 @@ def get_version_json(version_str):

def connect_jira(cmd):
 # ASF JIRA username
 jira_username = os.environ.get("JIRA_USERNAME")
 jira_username = os.environ.get("APACHE_JIRA_USERNAME")

 # ASF JIRA password
 jira_password = os.environ.get("JIRA_PASSWORD")
 jira_password = os.environ.get("APACHE_JIRA_PASSWORD")

 if not jira_username:
 jira_username = cmd.prompt("Env JIRA_USERNAME not set, "
 jira_username = cmd.prompt("Env APACHE_JIRA_USERNAME not set, "
 "please enter your JIRA username:")

 if not jira_password:
 jira_password = cmd.getpass("Env JIRA_PASSWORD not set, "
 jira_password = cmd.getpass("Env APACHE_JIRA_PASSWORD not set, "
 "please enter "
 "your JIRA password:")

Expand All@@ -444,15 +491,12 @@ def cli():

 pr_num = input("Which pull request would you like to merge? (e.g. 34): ")

 # Remote name which points to the GitHub site
 git_remote = os.environ.get("PR_REMOTE_NAME", "apache")

 os.chdir(ARROW_HOME)

 github_api = GitHubAPI(PROJECT_NAME)

 jira_con = connect_jira(cmd)
 pr = PullRequest(cmd, github_api, git_remote, jira_con, pr_num)
 pr = PullRequest(cmd, github_api, PR_REMOTE_NAME, jira_con, pr_num)

 if pr.is_merged:
 print("Pull request %s has already been merged")
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
ARROW-5716: [Developer] Improve merge PR script to attribute multiple authors#4882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

wesm
wants to merge
5
commits into

from

 Closed


ARROW-5716: [Developer] Improve merge PR script to attribute multiple authors
#4882
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
7924dab

Add support for lead/co-authors to merge script


wesm Jul 15, 2019
0ebc17e

Add debugging output


wesm Jul 15, 2019
6d65ceb

Fix DEBUG env variable flag logic [skip ci]


wesm Jul 15, 2019
74fb732

Put authors at end of commit message so GitHub understands them [skip…


wesm Jul 17, 2019
816a137

Do not prompt for lead author if there is only one person involved [s…


wesm Jul 17, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


76 changes: 60 additions & 16 deletions
dev/merge_arrow_pr.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,8 @@
# There are several pieces of authorization possibly needed via environment
# variables
#
# JIRA_USERNAME: your Apache JIRA id
# JIRA_PASSWORD: your Apache JIRA password
# APACHE_JIRA_USERNAME: your Apache JIRA id
# APACHE_JIRA_PASSWORD: your Apache JIRA password
# ARROW_GITHUB_API_TOKEN: a GitHub API token to use for API requests (to avoid
# rate limiting)

Expand All@@ -52,6 +52,16 @@
 print("Exiting without trying to close the associated JIRA.")
 sys.exit(1)

# Remote name which points to the GitHub site
PR_REMOTE_NAME = os.environ.get("PR_REMOTE_NAME", "apache")

# For testing to avoid accidentally pushing to apache
DEBUG = bool(int(os.environ.get("DEBUG", 0)))


if DEBUG:
 print("**************** DEBUGGING ****************")


# Prefix added to temporary branches
BRANCH_PREFIX = "PR_TOOL"
Expand DownExpand Up@@ -339,7 +349,27 @@ def merge(self, target_ref='master'):
 distinct_authors = sorted(set(commit_authors),
 key=lambda x: commit_authors.count(x),
 reverse=True)
 primary_author = distinct_authors[0]

 for i, author in enumerate(distinct_authors):
 print("Author {}: {}".format(i + 1, author))

 if len(distinct_authors) > 1:
 primary_author = self.cmd.prompt(
 "Enter primary author in the format of "
 "\"name <email>\" [%s]: " % distinct_authors[0])

 if primary_author == "":
 primary_author = distinct_authors[0]
 else:
 # When primary author is specified manually, de-dup it from
 # author list and put it at the head of author list.
 distinct_authors = [x for x in distinct_authors
 if x != primary_author]
 distinct_authors = [primary_author] + distinct_authors
 else:
 # If there is only one author, do not prompt for a lead author
 primary_author = distinct_authors[0]

 commits = run_cmd(['git', 'log', 'HEAD..%s' % pr_branch_name,
 '--pretty=format:%h <%an> %s']).split("\n\n")

Expand All@@ -349,9 +379,17 @@ def merge(self, target_ref='master'):
 if self.body is not None:
 merge_message_flags += ["-m", self.body]

 authors = "\n".join(["Author: %s" % a for a in distinct_authors])
 committer_name = run_cmd("git config --get user.name").strip()
 committer_email = run_cmd("git config --get user.email").strip()

 merge_message_flags += ["-m", authors]
 authors = ("Authored-by:" if len(distinct_authors) == 1
 else "Lead-authored-by:")
 authors += " %s" % (distinct_authors.pop(0))
 if len(distinct_authors) > 0:
 authors += "\n" + "\n".join(["Co-authored-by: %s" % a
 for a in distinct_authors])
 authors += "\n" + "Signed-off-by: %s <%s>" % (committer_name,
 committer_email)

 if had_conflicts:
 committer_name = run_cmd("git config --get user.name").strip()
Expand All@@ -371,6 +409,11 @@ def merge(self, target_ref='master'):
 stripped_message = strip_ci_directives(c).strip()
 merge_message_flags += ["-m", stripped_message]

 merge_message_flags += ["-m", authors]

 if DEBUG:
 print("\n".join(merge_message_flags))

 run_cmd(['git', 'commit',
 '--no-verify', # do not run commit hooks
 '--author="%s"' % primary_author] +
Expand All@@ -380,9 +423,13 @@ def merge(self, target_ref='master'):
 % (target_branch_name, self.git_remote))

 try:
 run_cmd('git push %s %s:%s' % (self.git_remote,
 target_branch_name,
 target_ref))
 push_cmd = ('git push %s %s:%s' % (self.git_remote,
 target_branch_name,
 target_ref))
 if DEBUG:
 print(push_cmd)
 else:
 run_cmd(push_cmd)
 except Exception as e:
 clean_up()
 self.cmd.fail("Exception while pushing: %s" % e)
Expand DownExpand Up@@ -415,17 +462,17 @@ def get_version_json(version_str):

def connect_jira(cmd):
 # ASF JIRA username
 jira_username = os.environ.get("JIRA_USERNAME")
 jira_username = os.environ.get("APACHE_JIRA_USERNAME")

 # ASF JIRA password
 jira_password = os.environ.get("JIRA_PASSWORD")
 jira_password = os.environ.get("APACHE_JIRA_PASSWORD")

 if not jira_username:
 jira_username = cmd.prompt("Env JIRA_USERNAME not set, "
 jira_username = cmd.prompt("Env APACHE_JIRA_USERNAME not set, "
 "please enter your JIRA username:")

 if not jira_password:
 jira_password = cmd.getpass("Env JIRA_PASSWORD not set, "
 jira_password = cmd.getpass("Env APACHE_JIRA_PASSWORD not set, "
 "please enter "
 "your JIRA password:")

Expand All@@ -444,15 +491,12 @@ def cli():

 pr_num = input("Which pull request would you like to merge? (e.g. 34): ")

 # Remote name which points to the GitHub site
 git_remote = os.environ.get("PR_REMOTE_NAME", "apache")

 os.chdir(ARROW_HOME)

 github_api = GitHubAPI(PROJECT_NAME)

 jira_con = connect_jira(cmd)
 pr = PullRequest(cmd, github_api, git_remote, jira_con, pr_num)
 pr = PullRequest(cmd, github_api, PR_REMOTE_NAME, jira_con, pr_num)

 if pr.is_merged:
 print("Pull request %s has already been merged")
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ARROW-5716: [Developer] Improve merge PR script to attribute multiple authors#4882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

wesm
wants to merge
5
commits into

from

 Closed


ARROW-5716: [Developer] Improve merge PR script to attribute multiple authors
#4882
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
7924dab

Add support for lead/co-authors to merge script


wesm Jul 15, 2019
0ebc17e

Add debugging output


wesm Jul 15, 2019
6d65ceb

Fix DEBUG env variable flag logic [skip ci]


wesm Jul 15, 2019
74fb732

Put authors at end of commit message so GitHub understands them [skip…


wesm Jul 17, 2019
816a137

Do not prompt for lead author if there is only one person involved [s…


wesm Jul 17, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


76 changes: 60 additions & 16 deletions
dev/merge_arrow_pr.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,8 @@
# There are several pieces of authorization possibly needed via environment
# variables
#
# JIRA_USERNAME: your Apache JIRA id
# JIRA_PASSWORD: your Apache JIRA password
# APACHE_JIRA_USERNAME: your Apache JIRA id
# APACHE_JIRA_PASSWORD: your Apache JIRA password
# ARROW_GITHUB_API_TOKEN: a GitHub API token to use for API requests (to avoid
# rate limiting)

Expand All@@ -52,6 +52,16 @@
 print("Exiting without trying to close the associated JIRA.")
 sys.exit(1)

# Remote name which points to the GitHub site
PR_REMOTE_NAME = os.environ.get("PR_REMOTE_NAME", "apache")

# For testing to avoid accidentally pushing to apache
DEBUG = bool(int(os.environ.get("DEBUG", 0)))


if DEBUG:
 print("**************** DEBUGGING ****************")


# Prefix added to temporary branches
BRANCH_PREFIX = "PR_TOOL"
Expand DownExpand Up@@ -339,7 +349,27 @@ def merge(self, target_ref='master'):
 distinct_authors = sorted(set(commit_authors),
 key=lambda x: commit_authors.count(x),
 reverse=True)
 primary_author = distinct_authors[0]

 for i, author in enumerate(distinct_authors):
 print("Author {}: {}".format(i + 1, author))

 if len(distinct_authors) > 1:
 primary_author = self.cmd.prompt(
 "Enter primary author in the format of "
 "\"name <email>\" [%s]: " % distinct_authors[0])

 if primary_author == "":
 primary_author = distinct_authors[0]
 else:
 # When primary author is specified manually, de-dup it from
 # author list and put it at the head of author list.
 distinct_authors = [x for x in distinct_authors
 if x != primary_author]
 distinct_authors = [primary_author] + distinct_authors
 else:
 # If there is only one author, do not prompt for a lead author
 primary_author = distinct_authors[0]

 commits = run_cmd(['git', 'log', 'HEAD..%s' % pr_branch_name,
 '--pretty=format:%h <%an> %s']).split("\n\n")

Expand All@@ -349,9 +379,17 @@ def merge(self, target_ref='master'):
 if self.body is not None:
 merge_message_flags += ["-m", self.body]

 authors = "\n".join(["Author: %s" % a for a in distinct_authors])
 committer_name = run_cmd("git config --get user.name").strip()
 committer_email = run_cmd("git config --get user.email").strip()

 merge_message_flags += ["-m", authors]
 authors = ("Authored-by:" if len(distinct_authors) == 1
 else "Lead-authored-by:")
 authors += " %s" % (distinct_authors.pop(0))
 if len(distinct_authors) > 0:
 authors += "\n" + "\n".join(["Co-authored-by: %s" % a
 for a in distinct_authors])
 authors += "\n" + "Signed-off-by: %s <%s>" % (committer_name,
 committer_email)

 if had_conflicts:
 committer_name = run_cmd("git config --get user.name").strip()
Expand All@@ -371,6 +409,11 @@ def merge(self, target_ref='master'):
 stripped_message = strip_ci_directives(c).strip()
 merge_message_flags += ["-m", stripped_message]

 merge_message_flags += ["-m", authors]

 if DEBUG:
 print("\n".join(merge_message_flags))

 run_cmd(['git', 'commit',
 '--no-verify', # do not run commit hooks
 '--author="%s"' % primary_author] +
Expand All@@ -380,9 +423,13 @@ def merge(self, target_ref='master'):
 % (target_branch_name, self.git_remote))

 try:
 run_cmd('git push %s %s:%s' % (self.git_remote,
 target_branch_name,
 target_ref))
 push_cmd = ('git push %s %s:%s' % (self.git_remote,
 target_branch_name,
 target_ref))
 if DEBUG:
 print(push_cmd)
 else:
 run_cmd(push_cmd)
 except Exception as e:
 clean_up()
 self.cmd.fail("Exception while pushing: %s" % e)
Expand DownExpand Up@@ -415,17 +462,17 @@ def get_version_json(version_str):

def connect_jira(cmd):
 # ASF JIRA username
 jira_username = os.environ.get("JIRA_USERNAME")
 jira_username = os.environ.get("APACHE_JIRA_USERNAME")

 # ASF JIRA password
 jira_password = os.environ.get("JIRA_PASSWORD")
 jira_password = os.environ.get("APACHE_JIRA_PASSWORD")

 if not jira_username:
 jira_username = cmd.prompt("Env JIRA_USERNAME not set, "
 jira_username = cmd.prompt("Env APACHE_JIRA_USERNAME not set, "
 "please enter your JIRA username:")

 if not jira_password:
 jira_password = cmd.getpass("Env JIRA_PASSWORD not set, "
 jira_password = cmd.getpass("Env APACHE_JIRA_PASSWORD not set, "
 "please enter "
 "your JIRA password:")

Expand All@@ -444,15 +491,12 @@ def cli():

 pr_num = input("Which pull request would you like to merge? (e.g. 34): ")

 # Remote name which points to the GitHub site
 git_remote = os.environ.get("PR_REMOTE_NAME", "apache")

 os.chdir(ARROW_HOME)

 github_api = GitHubAPI(PROJECT_NAME)

 jira_con = connect_jira(cmd)
 pr = PullRequest(cmd, github_api, git_remote, jira_con, pr_num)
 pr = PullRequest(cmd, github_api, PR_REMOTE_NAME, jira_con, pr_num)

 if pr.is_merged:
 print("Pull request %s has already been merged")
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ARROW-5716: [Developer] Improve merge PR script to attribute multiple authors#4882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

wesm
wants to merge
5
commits into

from

 Closed


ARROW-5716: [Developer] Improve merge PR script to attribute multiple authors
#4882
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
7924dab

Add support for lead/co-authors to merge script


wesm Jul 15, 2019
0ebc17e

Add debugging output


wesm Jul 15, 2019
6d65ceb

Fix DEBUG env variable flag logic [skip ci]


wesm Jul 15, 2019
74fb732

Put authors at end of commit message so GitHub understands them [skip…


wesm Jul 17, 2019
816a137

Do not prompt for lead author if there is only one person involved [s…


wesm Jul 17, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


76 changes: 60 additions & 16 deletions
dev/merge_arrow_pr.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,8 @@
# There are several pieces of authorization possibly needed via environment
# variables
#
# JIRA_USERNAME: your Apache JIRA id
# JIRA_PASSWORD: your Apache JIRA password
# APACHE_JIRA_USERNAME: your Apache JIRA id
# APACHE_JIRA_PASSWORD: your Apache JIRA password
# ARROW_GITHUB_API_TOKEN: a GitHub API token to use for API requests (to avoid
# rate limiting)

Expand All@@ -52,6 +52,16 @@
 print("Exiting without trying to close the associated JIRA.")
 sys.exit(1)

# Remote name which points to the GitHub site
PR_REMOTE_NAME = os.environ.get("PR_REMOTE_NAME", "apache")

# For testing to avoid accidentally pushing to apache
DEBUG = bool(int(os.environ.get("DEBUG", 0)))


if DEBUG:
 print("**************** DEBUGGING ****************")


# Prefix added to temporary branches
BRANCH_PREFIX = "PR_TOOL"
Expand DownExpand Up@@ -339,7 +349,27 @@ def merge(self, target_ref='master'):
 distinct_authors = sorted(set(commit_authors),
 key=lambda x: commit_authors.count(x),
 reverse=True)
 primary_author = distinct_authors[0]

 for i, author in enumerate(distinct_authors):
 print("Author {}: {}".format(i + 1, author))

 if len(distinct_authors) > 1:
 primary_author = self.cmd.prompt(
 "Enter primary author in the format of "
 "\"name <email>\" [%s]: " % distinct_authors[0])

 if primary_author == "":
 primary_author = distinct_authors[0]
 else:
 # When primary author is specified manually, de-dup it from
 # author list and put it at the head of author list.
 distinct_authors = [x for x in distinct_authors
 if x != primary_author]
 distinct_authors = [primary_author] + distinct_authors
 else:
 # If there is only one author, do not prompt for a lead author
 primary_author = distinct_authors[0]

 commits = run_cmd(['git', 'log', 'HEAD..%s' % pr_branch_name,
 '--pretty=format:%h <%an> %s']).split("\n\n")

Expand All@@ -349,9 +379,17 @@ def merge(self, target_ref='master'):
 if self.body is not None:
 merge_message_flags += ["-m", self.body]

 authors = "\n".join(["Author: %s" % a for a in distinct_authors])
 committer_name = run_cmd("git config --get user.name").strip()
 committer_email = run_cmd("git config --get user.email").strip()

 merge_message_flags += ["-m", authors]
 authors = ("Authored-by:" if len(distinct_authors) == 1
 else "Lead-authored-by:")
 authors += " %s" % (distinct_authors.pop(0))
 if len(distinct_authors) > 0:
 authors += "\n" + "\n".join(["Co-authored-by: %s" % a
 for a in distinct_authors])
 authors += "\n" + "Signed-off-by: %s <%s>" % (committer_name,
 committer_email)

 if had_conflicts:
 committer_name = run_cmd("git config --get user.name").strip()
Expand All@@ -371,6 +409,11 @@ def merge(self, target_ref='master'):
 stripped_message = strip_ci_directives(c).strip()
 merge_message_flags += ["-m", stripped_message]

 merge_message_flags += ["-m", authors]

 if DEBUG:
 print("\n".join(merge_message_flags))

 run_cmd(['git', 'commit',
 '--no-verify', # do not run commit hooks
 '--author="%s"' % primary_author] +
Expand All@@ -380,9 +423,13 @@ def merge(self, target_ref='master'):
 % (target_branch_name, self.git_remote))

 try:
 run_cmd('git push %s %s:%s' % (self.git_remote,
 target_branch_name,
 target_ref))
 push_cmd = ('git push %s %s:%s' % (self.git_remote,
 target_branch_name,
 target_ref))
 if DEBUG:
 print(push_cmd)
 else:
 run_cmd(push_cmd)
 except Exception as e:
 clean_up()
 self.cmd.fail("Exception while pushing: %s" % e)
Expand DownExpand Up@@ -415,17 +462,17 @@ def get_version_json(version_str):

def connect_jira(cmd):
 # ASF JIRA username
 jira_username = os.environ.get("JIRA_USERNAME")
 jira_username = os.environ.get("APACHE_JIRA_USERNAME")

 # ASF JIRA password
 jira_password = os.environ.get("JIRA_PASSWORD")
 jira_password = os.environ.get("APACHE_JIRA_PASSWORD")

 if not jira_username:
 jira_username = cmd.prompt("Env JIRA_USERNAME not set, "
 jira_username = cmd.prompt("Env APACHE_JIRA_USERNAME not set, "
 "please enter your JIRA username:")

 if not jira_password:
 jira_password = cmd.getpass("Env JIRA_PASSWORD not set, "
 jira_password = cmd.getpass("Env APACHE_JIRA_PASSWORD not set, "
 "please enter "
 "your JIRA password:")

Expand All@@ -444,15 +491,12 @@ def cli():

 pr_num = input("Which pull request would you like to merge? (e.g. 34): ")

 # Remote name which points to the GitHub site
 git_remote = os.environ.get("PR_REMOTE_NAME", "apache")

 os.chdir(ARROW_HOME)

 github_api = GitHubAPI(PROJECT_NAME)

 jira_con = connect_jira(cmd)
 pr = PullRequest(cmd, github_api, git_remote, jira_con, pr_num)
 pr = PullRequest(cmd, github_api, PR_REMOTE_NAME, jira_con, pr_num)

 if pr.is_merged:
 print("Pull request %s has already been merged")
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
ARROW-5716: [Developer] Improve merge PR script to attribute multiple authors#4882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

wesm
wants to merge
5
commits into

from

 Closed


ARROW-5716: [Developer] Improve merge PR script to attribute multiple authors
#4882
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
7924dab

Add support for lead/co-authors to merge script


wesm Jul 15, 2019
0ebc17e

Add debugging output


wesm Jul 15, 2019
6d65ceb

Fix DEBUG env variable flag logic [skip ci]


wesm Jul 15, 2019
74fb732

Put authors at end of commit message so GitHub understands them [skip…


wesm Jul 17, 2019
816a137

Do not prompt for lead author if there is only one person involved [s…


wesm Jul 17, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


76 changes: 60 additions & 16 deletions
dev/merge_arrow_pr.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,8 @@
# There are several pieces of authorization possibly needed via environment
# variables
#
# JIRA_USERNAME: your Apache JIRA id
# JIRA_PASSWORD: your Apache JIRA password
# APACHE_JIRA_USERNAME: your Apache JIRA id
# APACHE_JIRA_PASSWORD: your Apache JIRA password
# ARROW_GITHUB_API_TOKEN: a GitHub API token to use for API requests (to avoid
# rate limiting)

Expand All@@ -52,6 +52,16 @@
 print("Exiting without trying to close the associated JIRA.")
 sys.exit(1)

# Remote name which points to the GitHub site
PR_REMOTE_NAME = os.environ.get("PR_REMOTE_NAME", "apache")

# For testing to avoid accidentally pushing to apache
DEBUG = bool(int(os.environ.get("DEBUG", 0)))


if DEBUG:
 print("**************** DEBUGGING ****************")


# Prefix added to temporary branches
BRANCH_PREFIX = "PR_TOOL"
Expand DownExpand Up@@ -339,7 +349,27 @@ def merge(self, target_ref='master'):
 distinct_authors = sorted(set(commit_authors),
 key=lambda x: commit_authors.count(x),
 reverse=True)
 primary_author = distinct_authors[0]

 for i, author in enumerate(distinct_authors):
 print("Author {}: {}".format(i + 1, author))

 if len(distinct_authors) > 1:
 primary_author = self.cmd.prompt(
 "Enter primary author in the format of "
 "\"name <email>\" [%s]: " % distinct_authors[0])

 if primary_author == "":
 primary_author = distinct_authors[0]
 else:
 # When primary author is specified manually, de-dup it from
 # author list and put it at the head of author list.
 distinct_authors = [x for x in distinct_authors
 if x != primary_author]
 distinct_authors = [primary_author] + distinct_authors
 else:
 # If there is only one author, do not prompt for a lead author
 primary_author = distinct_authors[0]

 commits = run_cmd(['git', 'log', 'HEAD..%s' % pr_branch_name,
 '--pretty=format:%h <%an> %s']).split("\n\n")

Expand All@@ -349,9 +379,17 @@ def merge(self, target_ref='master'):
 if self.body is not None:
 merge_message_flags += ["-m", self.body]

 authors = "\n".join(["Author: %s" % a for a in distinct_authors])
 committer_name = run_cmd("git config --get user.name").strip()
 committer_email = run_cmd("git config --get user.email").strip()

 merge_message_flags += ["-m", authors]
 authors = ("Authored-by:" if len(distinct_authors) == 1
 else "Lead-authored-by:")
 authors += " %s" % (distinct_authors.pop(0))
 if len(distinct_authors) > 0:
 authors += "\n" + "\n".join(["Co-authored-by: %s" % a
 for a in distinct_authors])
 authors += "\n" + "Signed-off-by: %s <%s>" % (committer_name,
 committer_email)

 if had_conflicts:
 committer_name = run_cmd("git config --get user.name").strip()
Expand All@@ -371,6 +409,11 @@ def merge(self, target_ref='master'):
 stripped_message = strip_ci_directives(c).strip()
 merge_message_flags += ["-m", stripped_message]

 merge_message_flags += ["-m", authors]

 if DEBUG:
 print("\n".join(merge_message_flags))

 run_cmd(['git', 'commit',
 '--no-verify', # do not run commit hooks
 '--author="%s"' % primary_author] +
Expand All@@ -380,9 +423,13 @@ def merge(self, target_ref='master'):
 % (target_branch_name, self.git_remote))

 try:
 run_cmd('git push %s %s:%s' % (self.git_remote,
 target_branch_name,
 target_ref))
 push_cmd = ('git push %s %s:%s' % (self.git_remote,
 target_branch_name,
 target_ref))
 if DEBUG:
 print(push_cmd)
 else:
 run_cmd(push_cmd)
 except Exception as e:
 clean_up()
 self.cmd.fail("Exception while pushing: %s" % e)
Expand DownExpand Up@@ -415,17 +462,17 @@ def get_version_json(version_str):

def connect_jira(cmd):
 # ASF JIRA username
 jira_username = os.environ.get("JIRA_USERNAME")
 jira_username = os.environ.get("APACHE_JIRA_USERNAME")

 # ASF JIRA password
 jira_password = os.environ.get("JIRA_PASSWORD")
 jira_password = os.environ.get("APACHE_JIRA_PASSWORD")

 if not jira_username:
 jira_username = cmd.prompt("Env JIRA_USERNAME not set, "
 jira_username = cmd.prompt("Env APACHE_JIRA_USERNAME not set, "
 "please enter your JIRA username:")

 if not jira_password:
 jira_password = cmd.getpass("Env JIRA_PASSWORD not set, "
 jira_password = cmd.getpass("Env APACHE_JIRA_PASSWORD not set, "
 "please enter "
 "your JIRA password:")

Expand All@@ -444,15 +491,12 @@ def cli():

 pr_num = input("Which pull request would you like to merge? (e.g. 34): ")

 # Remote name which points to the GitHub site
 git_remote = os.environ.get("PR_REMOTE_NAME", "apache")

 os.chdir(ARROW_HOME)

 github_api = GitHubAPI(PROJECT_NAME)

 jira_con = connect_jira(cmd)
 pr = PullRequest(cmd, github_api, git_remote, jira_con, pr_num)
 pr = PullRequest(cmd, github_api, PR_REMOTE_NAME, jira_con, pr_num)

 if pr.is_merged:
 print("Pull request %s has already been merged")
Expand Down