Skip to content

Commit 872645d

Browse files
Fokkoraulcd
andauthored
Update dev/README.md (#517)
* Update `dev/README.md` * Whoops Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com> --------- Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
1 parent ae39061 commit 872645d

File tree

1 file changed

+3
-72
lines changed

1 file changed

+3
-72
lines changed

dev/README.md

Lines changed: 3 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -17,77 +17,8 @@
1717
- under the License.
1818
-->
1919

20-
# Parquet Developer Scripts
21-
This directory contains scripts useful to developers when packaging,
22-
testing, or committing to Parquet.
20+
# Apache Parquet Release Scripts
2321

24-
Merging a pull request requires being a committer on the project.
22+
This directory contains scripts useful to developers when running the Parquet release.
2523

26-
* How to merge a Pull request:
27-
have an apache and apache-github remote setup
28-
```
29-
git remote add apache-github git@github.com:apache/incubator-parquet-format.git
30-
git remote add apache https://git-wip-us.apache.org/repos/asf/incubator-parquet-format.git
31-
```
32-
run the following command
33-
```
34-
dev/merge_parquet_pr.py
35-
```
36-
37-
Note:
38-
* The parent directory of your parquet repository must be called parquet-format
39-
* Without jira-python installed you'll have to close the JIRA manually
40-
41-
example output:
42-
```
43-
Which pull request would you like to merge? (e.g. 34):
44-
```
45-
Type the pull request number (from https://github.com/apache/incubator-parquet-format/pulls) and hit enter.
46-
```
47-
=== Pull Request #X ===
48-
title Blah Blah Blah
49-
source repo/branch
50-
target master
51-
url https://api.github.com/repos/apache/incubator-parquet-format/pulls/X
52-
53-
Proceed with merging pull request #3? (y/n):
54-
```
55-
If this looks good, type y and hit enter.
56-
```
57-
From git-wip-us.apache.org:/repos/asf/incubator-parquet-format.git
58-
* [new branch] master -> PR_TOOL_MERGE_PR_3_MASTER
59-
Switched to branch 'PR_TOOL_MERGE_PR_3_MASTER'
60-
61-
Merge complete (local ref PR_TOOL_MERGE_PR_3_MASTER). Push to apache? (y/n):
62-
```
63-
A local branch with the merge has been created.
64-
type y and hit enter to push it to apache master
65-
```
66-
Counting objects: 67, done.
67-
Delta compression using up to 4 threads.
68-
Compressing objects: 100% (26/26), done.
69-
Writing objects: 100% (36/36), 5.32 KiB, done.
70-
Total 36 (delta 17), reused 0 (delta 0)
71-
To git-wip-us.apache.org:/repos/asf/incubator-parquet-format.git
72-
b767ac4..485658a PR_TOOL_MERGE_PR_X_MASTER -> master
73-
Restoring head pointer to b767ac4e
74-
Note: checking out 'b767ac4e'.
75-
76-
You are in 'detached HEAD' state. You can look around, make experimental
77-
changes and commit them, and you can discard any commits you make in this
78-
state without impacting any branches by performing another checkout.
79-
80-
If you want to create a new branch to retain commits you create, you may
81-
do so (now or later) by using -b with the checkout command again. Example:
82-
83-
git checkout -b new_branch_name
84-
85-
HEAD is now at b767ac4... Update README.md
86-
Deleting local branch PR_TOOL_MERGE_PR_X
87-
Deleting local branch PR_TOOL_MERGE_PR_X_MASTER
88-
Pull request #X merged!
89-
Merge hash: 485658a5
90-
91-
Would you like to pick 485658a5 into another branch? (y/n):
92-
```
93-
For now just say n as we have 1 branch
24+
The mechanics of the parquet-format release are analog to parquet-java, which can be found [here](https://parquet.apache.org/docs/contribution-guidelines/releasing/).

0 commit comments

Comments
 (0)