Skip to content

Commit ca473de

Browse files
committed
Describe dev/release/bump_version.sh
1 parent 191e584 commit ca473de

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

dev/release/README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,43 @@
2222
## Overview
2323

2424
1. Test the revision to be released
25-
2. Bump version by `dev/release/bump_version.sh X.Y.Z`
25+
2. Bump version (detailed later)
2626
3. Prepare RC and vote (detailed later)
2727
4. Publish (detailed later)
2828
5. Bump version by `dev/release/bump_version.sh X.Y.Z-SNAPSHOT`
2929

30+
### Bump version
31+
32+
Run `dev/release/bump_version.sh` on a working copy of your fork not
33+
`[email protected]:apache/arrow-java`:
34+
35+
```console
36+
$ git clone [email protected]:${YOUR_GITHUB_ACCOUNT}/arrow-java.git arrow-java.${YOUR_GITHUB_ACCOUNT}
37+
$ cd arrow-java.${YOUR_GITHUB_ACCOUNT}
38+
$ GH_TOKEN=${YOUR_GITHUB_TOKEN} dev/release/bump_version.sh ${NEW_VERSION}
39+
```
40+
41+
Here is an example to bump version to 19.0.0:
42+
43+
```
44+
$ GH_TOKEN=${YOUR_GITHUB_TOKEN} dev/release/bump_version.sh 19.0.0
45+
```
46+
47+
It creates a feature branch and adds a commit that bumps version. This
48+
opens a pull request from the feature branch by `gh gr create`. So you
49+
need `gh` command and GitHub personal access token.
50+
51+
See also:
52+
https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens
53+
3054
### Prepare RC and vote
3155

3256
Run `dev/release/release_rc.sh` on a working copy of
3357
`[email protected]:apache/arrow-java` not your fork:
3458

3559
```console
3660
$ git clone [email protected]:apache/arrow-java.git
61+
$ cd arrow-java
3762
$ dev/release/release_rc.sh ${RC}
3863
(Send a vote email to [email protected].
3964
You can use a draft shown by release_rc.sh for the email.)

0 commit comments

Comments
 (0)