Skip to content

Commit 40cc787

Browse files
authored
chore: Improve release process (#2381)
## Which issue does this PR close? <!-- We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123. --> - Closes #. ## What changes are included in this PR? - Improve release process doc <!-- Provide a summary of the modifications in this PR. List the main changes such as new features, bug fixes, refactoring, or any other updates. --> ## Are these changes tested? not needed <!-- Specify what test covers (unit test, integration test, etc.). If tests are not included in your PR, please explain why (for example, are they covered by existing tests)? -->
1 parent 88ca8b6 commit 40cc787

1 file changed

Lines changed: 27 additions & 24 deletions

File tree

website/src/release.md

Lines changed: 27 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,7 @@ dist
160160
├── apache-iceberg-rust-0.2.0.tar.gz.asc
161161
└── apache-iceberg-rust-0.2.0.tar.gz.sha512
162162
```
163+
It is recommended to verify the artifacts yourself before uploading them to the SVN dist repo, see [How to verify a release](#how-to-verify-a-release)
163164

164165
### Upload artifacts to the SVN dist repo
165166

@@ -176,7 +177,9 @@ svn co https://dist.apache.org/repos/dist/dev/iceberg/ /tmp/iceberg-dist-dev
176177

177178
Then, upload the artifacts:
178179

179-
> The `${release_version}` here should be like `0.2.0-rc.1`
180+
> The `${release_version}` here should be like `0.2.0-rc1`
181+
182+
Example of uploaded artifacts can be found at: https://dist.apache.org/repos/dist/dev/iceberg/apache-iceberg-rust-0.9.1-rc3/
180183

181184
```shell
182185
# create a directory named by version
@@ -190,7 +193,8 @@ cd /tmp/iceberg-dist-dev/
190193

191194
# check svn status
192195
svn status
193-
196+
```
197+
```shell
194198
# add to svn
195199
svn add apache-iceberg-rust-${release_version}
196200

@@ -220,11 +224,11 @@ Title:
220224
Content:
221225

222226
```
223-
Hello, Apache Iceberg Rust Community,
227+
Hello Apache Iceberg Rust Community,
224228
225-
This is a call for a vote to release Apache Iceberg rust version ${iceberg_version}.
229+
This is a call for a vote to release Apache Iceberg Rust version ${iceberg_version}.
226230
227-
The tag to be voted on is v${release_version}.
231+
The tag to be voted on is: v${release_version}.
228232
229233
The release candidate:
230234
@@ -238,30 +242,30 @@ Git tag for the release:
238242
239243
https://github.com/apache/iceberg-rust/releases/tag/v${release_version}
240244
241-
Please download, verify, and test.
245+
Please download, verify, and test the release candidate.
242246
243-
The VOTE will be open for at least 72 hours and until the necessary
244-
number of votes are reached.
247+
This vote will be open for at least 72 hours and will remain open until the required number of votes is reached.
245248
246-
[ ] +1 approve
247-
[ ] +0 no opinion
248-
[ ] -1 disapprove with the reason
249+
Please vote accordingly:
250+
[ ] +1 Approve
251+
[ ] +0 No opinion
252+
[ ] -1 Disapprove (please provide a reason)
249253
250-
To learn more about Apache Iceberg, please see https://rust.iceberg.apache.org/
254+
To learn more about Apache Iceberg, please visit:
255+
https://rust.iceberg.apache.org/
251256
252257
Checklist for reference:
253-
254-
[ ] Download links are valid.
255-
[ ] Checksums and signatures.
256-
[ ] LICENSE/NOTICE files exist
257-
[ ] No unexpected binary files
258+
[ ] Download links are valid
259+
[ ] Checksums and signatures are correct
260+
[ ] LICENSE and NOTICE files are present
261+
[ ] No unexpected binary files are included
258262
[ ] All source files have ASF headers
259-
[ ] Can compile from source
263+
[ ] The project builds successfully from source
260264
261-
More details please refer to https://rust.iceberg.apache.org/release.html#how-to-verify-a-release.
262-
263-
Thanks
265+
For more details, please refer to:
266+
https://rust.iceberg.apache.org/release.html#how-to-verify-a-release
264267
268+
Thanks,
265269
${name}
266270
```
267271

@@ -278,7 +282,7 @@ Title:
278282
Content:
279283

280284
```
281-
Hello, Apache Iceberg Rust Community,
285+
Hello Apache Iceberg Rust Community,
282286
283287
The vote to release Apache Iceberg Rust ${release_version} has passed.
284288
@@ -296,8 +300,7 @@ Non-Binding votes:
296300
297301
Vote thread: ${vote_thread_url}
298302
299-
Thanks
300-
303+
Thanks,
301304
${name}
302305
```
303306

0 commit comments

Comments
 (0)