Skip to content

Commit

Permalink
GH-41620: [Docs] Document merge.conf usage (#41621)
Browse files Browse the repository at this point in the history
### 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 <dpitkin@apache.org>
Signed-off-by: Dane Pitkin <dpitkin@apache.org>
  • Loading branch information
danepitkin committed May 17, 2024
1 parent 14b8ca5 commit 8d687b0
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 8d687b0

Please sign in to comment.