This is an automated email from the ASF dual-hosted git repository.
dpitkin pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new 8d687b0cfc GH-41620: [Docs] Document merge.conf usage (#41621)
8d687b0cfc is described below
commit 8d687b0cfc77609e1e66c7ad500638016d41709b
Author: Dane Pitkin <[email protected]>
AuthorDate: Fri May 17 12:25:09 2024 -0400
GH-41620: [Docs] Document merge.conf usage (#41621)
### Rationale for this change
As a new committer, I found that the usage of `merge.conf` was not
documented and that a placeholder Jira token is still required, even though
Arrow no longer uses Jira.
### What changes are included in this PR?
* Document merge.conf usage
### Are these changes tested?
n/a
### Are there any user-facing changes?
No
* GitHub Issue: #41620
Authored-by: Dane Pitkin <[email protected]>
Signed-off-by: Dane Pitkin <[email protected]>
---
dev/README.md | 23 +++++++++++++++++++----
1 file changed, 19 insertions(+), 4 deletions(-)
diff --git a/dev/README.md b/dev/README.md
index db9a10d527..b04dd35b1c 100644
--- a/dev/README.md
+++ b/dev/README.md
@@ -48,17 +48,32 @@ After installed, it runs the merge script.
you'll have to install Python dependencies yourself and then run
`dev/merge_arrow_pr.py` directly.)
+The merge script requires tokens for access control. There are two options
+for configuring your tokens: environment variables or a configuration file.
+
+> Note: Arrow only requires a GitHub token. Parquet can use GitHub or
+JIRA tokens.
+
+#### Pass tokens via Environment Variables
+
The merge script uses the GitHub REST API. You must set a
-`ARROW_GITHUB_API_TOKEN` environment variable to use a
-[Personal Access
Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
+`ARROW_GITHUB_API_TOKEN` environment variable to use a
+[Personal Access
Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
You need to add `workflow` scope to the Personal Access Token.
-You can specify the
+You can specify the
[Personal Access
Token](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html)
-of your JIRA account in the
+of your JIRA account in the
`APACHE_JIRA_TOKEN` environment variable.
If the variable is not set, the script will ask you for it.
+#### Pass tokens via configuration file
+
+```
+cp ./merge.conf.sample ~/.config/arrow/merge.conf
+```
+Update your new `merge.conf` file with your Personal Access Tokens.
+
Example output:
```text
