Skip to content

GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arrow_pr.py#38301

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

Merged
raulcd merged 3 commits into from
Oct 23, 2023
Merged

GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arrow_pr.py #38301

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c2cccac
GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arro…
kou Oct 16, 2023
024d57b
Remove Jira's example output
kou Oct 18, 2023
32e18e4
Remove garbage
kou Oct 18, 2023
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
73 changes: 18 additions & 55 deletions dev/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,27 +31,22 @@ NOTE: It may take some time (a few hours) between when you complete
the setup at GitBox, and when your GitHub account will be added as a
committer.

## How to merge a Pull request
## How to Merge a Pull Request

Please don't merge PRs using the Github Web interface. Instead, set up
your git clone such as to have a remote named ``apache`` pointing to the
official Arrow repository:
```
git remote add apache git@github.com:apache/arrow.git
```
Please don't merge PRs using the GitHub Web interface. Instead, run
the following command:

and then run the following command:
```
./dev/merge_arrow_pr.sh
```bash
dev/merge_arrow_pr.sh
```

This creates a new Python virtual environment under `dev/.venv[PY_VERSION]`
and installs all the necessary dependencies to run the Arrow merge script.
After installed, it runs the merge script.

(we don't provide a wrapper script for Windows yet, so under Windows you'll
have to install Python dependencies yourself and then run `dev/merge_arrow_pr.py`
directly)
(We don't provide a wrapper script for Windows yet, so under Windows
you'll have to install Python dependencies yourself and then run
`dev/merge_arrow_pr.py` directly.)

The merge script uses the GitHub REST API. You must set a
`ARROW_GITHUB_API_TOKEN` environment variable to use a
Expand All@@ -64,30 +59,16 @@ of your JIRA account in the
`APACHE_JIRA_TOKEN` environment variable.
If the variable is not set, the script will ask you for it.

Note that the directory name of your Arrow git clone must be called `arrow`.
Example output:

example output:
```
```text
Which pull request would you like to merge? (e.g. 34):
```
Type the pull request number (from https://github.com/apache/arrow/pulls) and hit enter.
```
=== Pull Request #X ===
title Blah Blah Blah
source repo/branch
target master
url https://api.github.com/apache/arrow/pulls/X
=== JIRA ARROW-#Y ===
Summary Blah Blah Blah
Assignee Name
Components C++
Status In Progress
URL https://issues.apache.org/jira/browse/ARROW-#Y

Proceed with merging pull request #X? (y/n):
```
Type the pull request number (from
https://github.com/apache/arrow/pulls) and hit enter:

```
```text
=== Pull Request #X ===
title GH-#Y: [Component] Title
source repo/branch
Expand All@@ -103,17 +84,9 @@ URL https://github.com/apache/arrow/issues/Y
Proceed with merging pull request #X? (y/n): y
```

If this looks good, type y and hit enter.
```
Author 1: Name
Pull request #X merged!
Merge hash: #hash
If this looks good, type `y` and hit enter:

Would you like to update the associated JIRA? (y/n): y
Enter comma-separated fix version(s) [11.0.0]:
```

```
```text
Author 1: Name
Pull request #X merged!
Merge hash: #hash
Expand All@@ -122,27 +95,17 @@ Would you like to update the associated issue? (y/n): y
Enter fix version [11.0.0]:
```

You can just hit enter and the associated JIRA or GitHub issue
You can just hit enter and the associated GitHub issue
will be resolved with the current fix version.

```
Successfully resolved ARROW-#Y!
=== JIRA ARROW-#Y ===
Summary Blah Blah Blah
Assignee Name
Components C++
Status Resolved
URL https://issues.apache.org/jira/browse/ARROW-#Y
```

```
```text
Successfully resolved #Y!
=== GITHUB #Y ===
Summary [Component] Title
Assignee Name
Components Python
Status closed
URL https://github.com/apache/arrow/issues/Y```
URL https://github.com/apache/arrow/issues/Y
```

## Verifying Release Candidates
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arrow_pr.py by kou · Pull Request #38301 · apache/arrow · GitHub
Skip to content
GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arrow_pr.py#38301

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

 Merged

raulcd
merged 3 commits into

from

Oct 23, 2023
 Merged


GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arrow_pr.py
#38301
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c2cccac

GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arro…


kou Oct 16, 2023
024d57b

Remove Jira's example output


kou Oct 18, 2023
32e18e4

Remove garbage


kou Oct 18, 2023

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


73 changes: 18 additions & 55 deletions
dev/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,27 +31,22 @@ NOTE: It may take some time (a few hours) between when you complete
the setup at GitBox, and when your GitHub account will be added as a
committer.

## How to merge a Pull request
## How to Merge a Pull Request

Please don't merge PRs using the Github Web interface. Instead, set up
your git clone such as to have a remote named ``apache`` pointing to the
official Arrow repository:
```
git remote add apache git@github.com:apache/arrow.git
```
Please don't merge PRs using the GitHub Web interface. Instead, run
the following command:

and then run the following command:
```
./dev/merge_arrow_pr.sh
```bash
dev/merge_arrow_pr.sh
```

This creates a new Python virtual environment under `dev/.venv[PY_VERSION]`
and installs all the necessary dependencies to run the Arrow merge script.
After installed, it runs the merge script.

(we don't provide a wrapper script for Windows yet, so under Windows you'll
have to install Python dependencies yourself and then run `dev/merge_arrow_pr.py`
directly)
(We don't provide a wrapper script for Windows yet, so under Windows
you'll have to install Python dependencies yourself and then run
`dev/merge_arrow_pr.py` directly.)

The merge script uses the GitHub REST API. You must set a
`ARROW_GITHUB_API_TOKEN` environment variable to use a 
Expand All@@ -64,30 +59,16 @@ of your JIRA account in the
`APACHE_JIRA_TOKEN` environment variable.
If the variable is not set, the script will ask you for it.

Note that the directory name of your Arrow git clone must be called `arrow`.
Example output:

example output:
```
```text
Which pull request would you like to merge? (e.g. 34):
```
Type the pull request number (from https://github.com/apache/arrow/pulls) and hit enter.
```
=== Pull Request #X ===
title	Blah Blah Blah
source	repo/branch
target	master
url	https://api.github.com/apache/arrow/pulls/X
=== JIRA ARROW-#Y ===
Summary Blah Blah Blah
Assignee	Name
Components	C++
Status In Progress
URL https://issues.apache.org/jira/browse/ARROW-#Y

Proceed with merging pull request #X? (y/n):
```
Type the pull request number (from
https://github.com/apache/arrow/pulls) and hit enter:

```
```text
=== Pull Request #X ===
title	GH-#Y: [Component] Title
source	repo/branch
Expand All@@ -103,17 +84,9 @@ URL https://github.com/apache/arrow/issues/Y
Proceed with merging pull request #X? (y/n): y
```

If this looks good, type y and hit enter.
```
Author 1: Name
Pull request #X merged!
Merge hash: #hash
If this looks good, type `y` and hit enter:

Would you like to update the associated JIRA? (y/n): y
Enter comma-separated fix version(s) [11.0.0]:
```

```
```text
Author 1: Name
Pull request #X merged!
Merge hash: #hash
Expand All@@ -122,27 +95,17 @@ Would you like to update the associated issue? (y/n): y
Enter fix version [11.0.0]:
```

You can just hit enter and the associated JIRA or GitHub issue
You can just hit enter and the associated GitHub issue
will be resolved with the current fix version.

```
Successfully resolved ARROW-#Y!
=== JIRA ARROW-#Y ===
Summary Blah Blah Blah
Assignee	Name
Components	C++
Status Resolved
URL https://issues.apache.org/jira/browse/ARROW-#Y
```

```
```text
Successfully resolved #Y!
=== GITHUB #Y ===
Summary [Component] Title
Assignee	Name
Components	Python
Status closed
URL https://github.com/apache/arrow/issues/Y```
URL https://github.com/apache/arrow/issues/Y
```

## Verifying Release Candidates
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arrow_pr.py by kou · Pull Request #38301 · apache/arrow · GitHub
Skip to content
GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arrow_pr.py#38301

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

 Merged

raulcd
merged 3 commits into

from

Oct 23, 2023
 Merged


GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arrow_pr.py
#38301
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c2cccac

GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arro…


kou Oct 16, 2023
024d57b

Remove Jira's example output


kou Oct 18, 2023
32e18e4

Remove garbage


kou Oct 18, 2023

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


73 changes: 18 additions & 55 deletions
dev/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,27 +31,22 @@ NOTE: It may take some time (a few hours) between when you complete
the setup at GitBox, and when your GitHub account will be added as a
committer.

## How to merge a Pull request
## How to Merge a Pull Request

Please don't merge PRs using the Github Web interface. Instead, set up
your git clone such as to have a remote named ``apache`` pointing to the
official Arrow repository:
```
git remote add apache git@github.com:apache/arrow.git
```
Please don't merge PRs using the GitHub Web interface. Instead, run
the following command:

and then run the following command:
```
./dev/merge_arrow_pr.sh
```bash
dev/merge_arrow_pr.sh
```

This creates a new Python virtual environment under `dev/.venv[PY_VERSION]`
and installs all the necessary dependencies to run the Arrow merge script.
After installed, it runs the merge script.

(we don't provide a wrapper script for Windows yet, so under Windows you'll
have to install Python dependencies yourself and then run `dev/merge_arrow_pr.py`
directly)
(We don't provide a wrapper script for Windows yet, so under Windows
you'll have to install Python dependencies yourself and then run
`dev/merge_arrow_pr.py` directly.)

The merge script uses the GitHub REST API. You must set a
`ARROW_GITHUB_API_TOKEN` environment variable to use a 
Expand All@@ -64,30 +59,16 @@ of your JIRA account in the
`APACHE_JIRA_TOKEN` environment variable.
If the variable is not set, the script will ask you for it.

Note that the directory name of your Arrow git clone must be called `arrow`.
Example output:

example output:
```
```text
Which pull request would you like to merge? (e.g. 34):
```
Type the pull request number (from https://github.com/apache/arrow/pulls) and hit enter.
```
=== Pull Request #X ===
title	Blah Blah Blah
source	repo/branch
target	master
url	https://api.github.com/apache/arrow/pulls/X
=== JIRA ARROW-#Y ===
Summary Blah Blah Blah
Assignee	Name
Components	C++
Status In Progress
URL https://issues.apache.org/jira/browse/ARROW-#Y

Proceed with merging pull request #X? (y/n):
```
Type the pull request number (from
https://github.com/apache/arrow/pulls) and hit enter:

```
```text
=== Pull Request #X ===
title	GH-#Y: [Component] Title
source	repo/branch
Expand All@@ -103,17 +84,9 @@ URL https://github.com/apache/arrow/issues/Y
Proceed with merging pull request #X? (y/n): y
```

If this looks good, type y and hit enter.
```
Author 1: Name
Pull request #X merged!
Merge hash: #hash
If this looks good, type `y` and hit enter:

Would you like to update the associated JIRA? (y/n): y
Enter comma-separated fix version(s) [11.0.0]:
```

```
```text
Author 1: Name
Pull request #X merged!
Merge hash: #hash
Expand All@@ -122,27 +95,17 @@ Would you like to update the associated issue? (y/n): y
Enter fix version [11.0.0]:
```

You can just hit enter and the associated JIRA or GitHub issue
You can just hit enter and the associated GitHub issue
will be resolved with the current fix version.

```
Successfully resolved ARROW-#Y!
=== JIRA ARROW-#Y ===
Summary Blah Blah Blah
Assignee	Name
Components	C++
Status Resolved
URL https://issues.apache.org/jira/browse/ARROW-#Y
```

```
```text
Successfully resolved #Y!
=== GITHUB #Y ===
Summary [Component] Title
Assignee	Name
Components	Python
Status closed
URL https://github.com/apache/arrow/issues/Y```
URL https://github.com/apache/arrow/issues/Y
```

## Verifying Release Candidates
Expand Down

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

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

 Merged

raulcd
merged 3 commits into

from

Oct 23, 2023
 Merged


GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arrow_pr.py
#38301
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c2cccac

GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arro…


kou Oct 16, 2023
024d57b

Remove Jira's example output


kou Oct 18, 2023
32e18e4

Remove garbage


kou Oct 18, 2023

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


73 changes: 18 additions & 55 deletions
dev/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,27 +31,22 @@ NOTE: It may take some time (a few hours) between when you complete
the setup at GitBox, and when your GitHub account will be added as a
committer.

## How to merge a Pull request
## How to Merge a Pull Request

Please don't merge PRs using the Github Web interface. Instead, set up
your git clone such as to have a remote named ``apache`` pointing to the
official Arrow repository:
```
git remote add apache git@github.com:apache/arrow.git
```
Please don't merge PRs using the GitHub Web interface. Instead, run
the following command:

and then run the following command:
```
./dev/merge_arrow_pr.sh
```bash
dev/merge_arrow_pr.sh
```

This creates a new Python virtual environment under `dev/.venv[PY_VERSION]`
and installs all the necessary dependencies to run the Arrow merge script.
After installed, it runs the merge script.

(we don't provide a wrapper script for Windows yet, so under Windows you'll
have to install Python dependencies yourself and then run `dev/merge_arrow_pr.py`
directly)
(We don't provide a wrapper script for Windows yet, so under Windows
you'll have to install Python dependencies yourself and then run
`dev/merge_arrow_pr.py` directly.)

The merge script uses the GitHub REST API. You must set a
`ARROW_GITHUB_API_TOKEN` environment variable to use a 
Expand All@@ -64,30 +59,16 @@ of your JIRA account in the
`APACHE_JIRA_TOKEN` environment variable.
If the variable is not set, the script will ask you for it.

Note that the directory name of your Arrow git clone must be called `arrow`.
Example output:

example output:
```
```text
Which pull request would you like to merge? (e.g. 34):
```
Type the pull request number (from https://github.com/apache/arrow/pulls) and hit enter.
```
=== Pull Request #X ===
title	Blah Blah Blah
source	repo/branch
target	master
url	https://api.github.com/apache/arrow/pulls/X
=== JIRA ARROW-#Y ===
Summary Blah Blah Blah
Assignee	Name
Components	C++
Status In Progress
URL https://issues.apache.org/jira/browse/ARROW-#Y

Proceed with merging pull request #X? (y/n):
```
Type the pull request number (from
https://github.com/apache/arrow/pulls) and hit enter:

```
```text
=== Pull Request #X ===
title	GH-#Y: [Component] Title
source	repo/branch
Expand All@@ -103,17 +84,9 @@ URL https://github.com/apache/arrow/issues/Y
Proceed with merging pull request #X? (y/n): y
```

If this looks good, type y and hit enter.
```
Author 1: Name
Pull request #X merged!
Merge hash: #hash
If this looks good, type `y` and hit enter:

Would you like to update the associated JIRA? (y/n): y
Enter comma-separated fix version(s) [11.0.0]:
```

```
```text
Author 1: Name
Pull request #X merged!
Merge hash: #hash
Expand All@@ -122,27 +95,17 @@ Would you like to update the associated issue? (y/n): y
Enter fix version [11.0.0]:
```

You can just hit enter and the associated JIRA or GitHub issue
You can just hit enter and the associated GitHub issue
will be resolved with the current fix version.

```
Successfully resolved ARROW-#Y!
=== JIRA ARROW-#Y ===
Summary Blah Blah Blah
Assignee	Name
Components	C++
Status Resolved
URL https://issues.apache.org/jira/browse/ARROW-#Y
```

```
```text
Successfully resolved #Y!
=== GITHUB #Y ===
Summary [Component] Title
Assignee	Name
Components	Python
Status closed
URL https://github.com/apache/arrow/issues/Y```
URL https://github.com/apache/arrow/issues/Y
```

## Verifying Release Candidates
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arrow_pr.py by kou · Pull Request #38301 · apache/arrow · GitHub
Skip to content
GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arrow_pr.py#38301

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

 Merged

raulcd
merged 3 commits into

from

Oct 23, 2023
 Merged


GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arrow_pr.py
#38301
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c2cccac

GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arro…


kou Oct 16, 2023
024d57b

Remove Jira's example output


kou Oct 18, 2023
32e18e4

Remove garbage


kou Oct 18, 2023

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


73 changes: 18 additions & 55 deletions
dev/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,27 +31,22 @@ NOTE: It may take some time (a few hours) between when you complete
the setup at GitBox, and when your GitHub account will be added as a
committer.

## How to merge a Pull request
## How to Merge a Pull Request

Please don't merge PRs using the Github Web interface. Instead, set up
your git clone such as to have a remote named ``apache`` pointing to the
official Arrow repository:
```
git remote add apache git@github.com:apache/arrow.git
```
Please don't merge PRs using the GitHub Web interface. Instead, run
the following command:

and then run the following command:
```
./dev/merge_arrow_pr.sh
```bash
dev/merge_arrow_pr.sh
```

This creates a new Python virtual environment under `dev/.venv[PY_VERSION]`
and installs all the necessary dependencies to run the Arrow merge script.
After installed, it runs the merge script.

(we don't provide a wrapper script for Windows yet, so under Windows you'll
have to install Python dependencies yourself and then run `dev/merge_arrow_pr.py`
directly)
(We don't provide a wrapper script for Windows yet, so under Windows
you'll have to install Python dependencies yourself and then run
`dev/merge_arrow_pr.py` directly.)

The merge script uses the GitHub REST API. You must set a
`ARROW_GITHUB_API_TOKEN` environment variable to use a 
Expand All@@ -64,30 +59,16 @@ of your JIRA account in the
`APACHE_JIRA_TOKEN` environment variable.
If the variable is not set, the script will ask you for it.

Note that the directory name of your Arrow git clone must be called `arrow`.
Example output:

example output:
```
```text
Which pull request would you like to merge? (e.g. 34):
```
Type the pull request number (from https://github.com/apache/arrow/pulls) and hit enter.
```
=== Pull Request #X ===
title	Blah Blah Blah
source	repo/branch
target	master
url	https://api.github.com/apache/arrow/pulls/X
=== JIRA ARROW-#Y ===
Summary Blah Blah Blah
Assignee	Name
Components	C++
Status In Progress
URL https://issues.apache.org/jira/browse/ARROW-#Y

Proceed with merging pull request #X? (y/n):
```
Type the pull request number (from
https://github.com/apache/arrow/pulls) and hit enter:

```
```text
=== Pull Request #X ===
title	GH-#Y: [Component] Title
source	repo/branch
Expand All@@ -103,17 +84,9 @@ URL https://github.com/apache/arrow/issues/Y
Proceed with merging pull request #X? (y/n): y
```

If this looks good, type y and hit enter.
```
Author 1: Name
Pull request #X merged!
Merge hash: #hash
If this looks good, type `y` and hit enter:

Would you like to update the associated JIRA? (y/n): y
Enter comma-separated fix version(s) [11.0.0]:
```

```
```text
Author 1: Name
Pull request #X merged!
Merge hash: #hash
Expand All@@ -122,27 +95,17 @@ Would you like to update the associated issue? (y/n): y
Enter fix version [11.0.0]:
```

You can just hit enter and the associated JIRA or GitHub issue
You can just hit enter and the associated GitHub issue
will be resolved with the current fix version.

```
Successfully resolved ARROW-#Y!
=== JIRA ARROW-#Y ===
Summary Blah Blah Blah
Assignee	Name
Components	C++
Status Resolved
URL https://issues.apache.org/jira/browse/ARROW-#Y
```

```
```text
Successfully resolved #Y!
=== GITHUB #Y ===
Summary [Component] Title
Assignee	Name
Components	Python
Status closed
URL https://github.com/apache/arrow/issues/Y```
URL https://github.com/apache/arrow/issues/Y
```

## Verifying Release Candidates
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arrow_pr.py by kou · Pull Request #38301 · apache/arrow · GitHub
Skip to content
GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arrow_pr.py#38301

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

 Merged

raulcd
merged 3 commits into

from

Oct 23, 2023
 Merged


GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arrow_pr.py
#38301
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c2cccac

GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arro…


kou Oct 16, 2023
024d57b

Remove Jira's example output


kou Oct 18, 2023
32e18e4

Remove garbage


kou Oct 18, 2023

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


73 changes: 18 additions & 55 deletions
dev/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,27 +31,22 @@ NOTE: It may take some time (a few hours) between when you complete
the setup at GitBox, and when your GitHub account will be added as a
committer.

## How to merge a Pull request
## How to Merge a Pull Request

Please don't merge PRs using the Github Web interface. Instead, set up
your git clone such as to have a remote named ``apache`` pointing to the
official Arrow repository:
```
git remote add apache git@github.com:apache/arrow.git
```
Please don't merge PRs using the GitHub Web interface. Instead, run
the following command:

and then run the following command:
```
./dev/merge_arrow_pr.sh
```bash
dev/merge_arrow_pr.sh
```

This creates a new Python virtual environment under `dev/.venv[PY_VERSION]`
and installs all the necessary dependencies to run the Arrow merge script.
After installed, it runs the merge script.

(we don't provide a wrapper script for Windows yet, so under Windows you'll
have to install Python dependencies yourself and then run `dev/merge_arrow_pr.py`
directly)
(We don't provide a wrapper script for Windows yet, so under Windows
you'll have to install Python dependencies yourself and then run
`dev/merge_arrow_pr.py` directly.)

The merge script uses the GitHub REST API. You must set a
`ARROW_GITHUB_API_TOKEN` environment variable to use a 
Expand All@@ -64,30 +59,16 @@ of your JIRA account in the
`APACHE_JIRA_TOKEN` environment variable.
If the variable is not set, the script will ask you for it.

Note that the directory name of your Arrow git clone must be called `arrow`.
Example output:

example output:
```
```text
Which pull request would you like to merge? (e.g. 34):
```
Type the pull request number (from https://github.com/apache/arrow/pulls) and hit enter.
```
=== Pull Request #X ===
title	Blah Blah Blah
source	repo/branch
target	master
url	https://api.github.com/apache/arrow/pulls/X
=== JIRA ARROW-#Y ===
Summary Blah Blah Blah
Assignee	Name
Components	C++
Status In Progress
URL https://issues.apache.org/jira/browse/ARROW-#Y

Proceed with merging pull request #X? (y/n):
```
Type the pull request number (from
https://github.com/apache/arrow/pulls) and hit enter:

```
```text
=== Pull Request #X ===
title	GH-#Y: [Component] Title
source	repo/branch
Expand All@@ -103,17 +84,9 @@ URL https://github.com/apache/arrow/issues/Y
Proceed with merging pull request #X? (y/n): y
```

If this looks good, type y and hit enter.
```
Author 1: Name
Pull request #X merged!
Merge hash: #hash
If this looks good, type `y` and hit enter:

Would you like to update the associated JIRA? (y/n): y
Enter comma-separated fix version(s) [11.0.0]:
```

```
```text
Author 1: Name
Pull request #X merged!
Merge hash: #hash
Expand All@@ -122,27 +95,17 @@ Would you like to update the associated issue? (y/n): y
Enter fix version [11.0.0]:
```

You can just hit enter and the associated JIRA or GitHub issue
You can just hit enter and the associated GitHub issue
will be resolved with the current fix version.

```
Successfully resolved ARROW-#Y!
=== JIRA ARROW-#Y ===
Summary Blah Blah Blah
Assignee	Name
Components	C++
Status Resolved
URL https://issues.apache.org/jira/browse/ARROW-#Y
```

```
```text
Successfully resolved #Y!
=== GITHUB #Y ===
Summary [Component] Title
Assignee	Name
Components	Python
Status closed
URL https://github.com/apache/arrow/issues/Y```
URL https://github.com/apache/arrow/issues/Y
```

## Verifying Release Candidates
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
})();
GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arrow_pr.py by kou · Pull Request #38301 · apache/arrow · GitHub
Skip to content
GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arrow_pr.py#38301

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

 Merged

raulcd
merged 3 commits into

from

Oct 23, 2023
 Merged


GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arrow_pr.py
#38301
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c2cccac

GH-38300: [Dev][Docs] Update dev/README.md for the current merge_arro…


kou Oct 16, 2023
024d57b

Remove Jira's example output


kou Oct 18, 2023
32e18e4

Remove garbage


kou Oct 18, 2023

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


73 changes: 18 additions & 55 deletions
dev/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,27 +31,22 @@ NOTE: It may take some time (a few hours) between when you complete
the setup at GitBox, and when your GitHub account will be added as a
committer.

## How to merge a Pull request
## How to Merge a Pull Request

Please don't merge PRs using the Github Web interface. Instead, set up
your git clone such as to have a remote named ``apache`` pointing to the
official Arrow repository:
```
git remote add apache git@github.com:apache/arrow.git
```
Please don't merge PRs using the GitHub Web interface. Instead, run
the following command:

and then run the following command:
```
./dev/merge_arrow_pr.sh
```bash
dev/merge_arrow_pr.sh
```

This creates a new Python virtual environment under `dev/.venv[PY_VERSION]`
and installs all the necessary dependencies to run the Arrow merge script.
After installed, it runs the merge script.

(we don't provide a wrapper script for Windows yet, so under Windows you'll
have to install Python dependencies yourself and then run `dev/merge_arrow_pr.py`
directly)
(We don't provide a wrapper script for Windows yet, so under Windows
you'll have to install Python dependencies yourself and then run
`dev/merge_arrow_pr.py` directly.)

The merge script uses the GitHub REST API. You must set a
`ARROW_GITHUB_API_TOKEN` environment variable to use a 
Expand All@@ -64,30 +59,16 @@ of your JIRA account in the
`APACHE_JIRA_TOKEN` environment variable.
If the variable is not set, the script will ask you for it.

Note that the directory name of your Arrow git clone must be called `arrow`.
Example output:

example output:
```
```text
Which pull request would you like to merge? (e.g. 34):
```
Type the pull request number (from https://github.com/apache/arrow/pulls) and hit enter.
```
=== Pull Request #X ===
title	Blah Blah Blah
source	repo/branch
target	master
url	https://api.github.com/apache/arrow/pulls/X
=== JIRA ARROW-#Y ===
Summary Blah Blah Blah
Assignee	Name
Components	C++
Status In Progress
URL https://issues.apache.org/jira/browse/ARROW-#Y

Proceed with merging pull request #X? (y/n):
```
Type the pull request number (from
https://github.com/apache/arrow/pulls) and hit enter:

```
```text
=== Pull Request #X ===
title	GH-#Y: [Component] Title
source	repo/branch
Expand All@@ -103,17 +84,9 @@ URL https://github.com/apache/arrow/issues/Y
Proceed with merging pull request #X? (y/n): y
```

If this looks good, type y and hit enter.
```
Author 1: Name
Pull request #X merged!
Merge hash: #hash
If this looks good, type `y` and hit enter:

Would you like to update the associated JIRA? (y/n): y
Enter comma-separated fix version(s) [11.0.0]:
```

```
```text
Author 1: Name
Pull request #X merged!
Merge hash: #hash
Expand All@@ -122,27 +95,17 @@ Would you like to update the associated issue? (y/n): y
Enter fix version [11.0.0]:
```

You can just hit enter and the associated JIRA or GitHub issue
You can just hit enter and the associated GitHub issue
will be resolved with the current fix version.

```
Successfully resolved ARROW-#Y!
=== JIRA ARROW-#Y ===
Summary Blah Blah Blah
Assignee	Name
Components	C++
Status Resolved
URL https://issues.apache.org/jira/browse/ARROW-#Y
```

```
```text
Successfully resolved #Y!
=== GITHUB #Y ===
Summary [Component] Title
Assignee	Name
Components	Python
Status closed
URL https://github.com/apache/arrow/issues/Y```
URL https://github.com/apache/arrow/issues/Y
```

## Verifying Release Candidates
Expand Down