@@ -294,60 +294,79 @@ Thanks to everyone for contributing!
294
294
295
295
#### Codebase updates
296
296
297
- There are a few places in the codebase that reference the latest Iceberg releases and need to be updated:
297
+ There are a few places in the codebase that reference the latest Iceberg release version number and need to be updated:
298
298
1 . https://github.com/apache/iceberg/blob/master/.github/ISSUE_TEMPLATE/iceberg_bug_report.yml
299
299
2 . https://github.com/apache/iceberg/blob/master/python/dev/Dockerfile
300
300
3 . ` oldVersion ` in ` revapi ` in https://github.com/apache/iceberg/blob/master/build.gradle
301
301
302
- ### Documentation Release
302
+ ### Documentation release
303
303
304
304
Documentation needs to be updated as a part of an Iceberg release after a release candidate is passed.
305
- The commands described below assume you are in a directory containing a local clone of the ` iceberg-docs `
306
- repository and ` iceberg ` repository. Adjust the commands accordingly if it is not the case. Note that all
307
- changes in ` iceberg ` need to happen against the ` master ` branch and changes in ` iceberg-docs ` need to happen
308
- against the ` main ` branch.
309
305
310
- #### Common documentation update
306
+ #### Prerequisites
311
307
312
- 1 . To start the release process, run the following steps in the ` iceberg-docs ` repository to copy docs over:
313
- ``` shell
314
- cp -r ../iceberg/format/* ../iceberg-docs/landing-page/content/common/
308
+ Similar to the ` iceberg ` repository, you also need to set up ` https://github.com/apache/iceberg-docs.git ` as a remote with name ` apache ` .
309
+
310
+ The commands described below assume you have a directory structure of:
311
+
312
+ ``` text
313
+ /some/path
314
+ ├── iceberg
315
+ └── iceberg-docs
315
316
```
316
- 2 . Change into the ` iceberg-docs ` repository and create a branch.
317
+
318
+ And you are:
319
+ 1 . in the ` iceberg-docs ` repository.
320
+ 2 . have ` iceberg ` repository on the specific version branch
321
+
322
+ Adjust the commands below accordingly if it is not the case.
323
+
324
+ #### Update specs
325
+
326
+ Copy the latest format specifications to ` landing-page/content/common ` :
327
+
317
328
``` shell
318
- cd ../iceberg-docs
319
- git checkout -b < BRANCH NAME>
329
+ cp -r ../iceberg/format/* ../iceberg-docs/landing-page/content/common/
320
330
```
321
- 3 . Commit, push, and open a PR against the ` iceberg-docs ` repo (` <BRANCH NAME> ` -> ` main ` )
322
331
323
- #### Versioned documentation update
332
+ Raise a PR with the specific changes against ` main ` branch and merge.
333
+
334
+ #### Create version branch
324
335
325
- Once the common docs changes have been merged into ` main ` , the next step is to update the versioned docs.
336
+ Create a branch with the specific version number:
326
337
327
- 1 . In the ` iceberg-docs ` repository, cut a new branch using the version number as the branch name
328
338
``` shell
329
- cd ../iceberg-docs
339
+ # sync main to latest first
330
340
git checkout -b < VERSION>
331
341
git push --set-upstream apache < VERSION>
332
342
```
333
- 2 . Copy the versioned docs from the ` iceberg ` repo into the ` iceberg-docs ` repo
343
+
344
+ #### Copy versioned documentations
345
+
346
+ Copy the versioned docs into ` docs/content `
347
+
334
348
``` shell
335
349
rm -rf ../iceberg-docs/docs/content
336
350
cp -r ../iceberg/docs ../iceberg-docs/docs/content
337
351
```
338
- 3 . Commit the changes and open a PR against the ` <VERSION> ` branch in the ` iceberg-docs ` repo
339
352
340
- #### Javadoc update
353
+ Raise a PR with the specific changes against ` <VERSION> ` branch and merge.
354
+
355
+ #### Copy versioned Javadoc
356
+
357
+
358
+
359
+ In the ` iceberg ` repository, generate the javadoc for your release and copy it to the ` javadoc ` folder:
341
360
342
- In the ` iceberg ` repository, generate the javadoc for your release and copy it to the ` javadoc ` folder in ` iceberg-docs ` repo:
343
361
``` shell
344
362
cd ../iceberg
363
+ echo " <VERSION>" > version.txt
345
364
./gradlew refreshJavadoc
346
365
rm -rf ../iceberg-docs/javadoc
347
- cp -r site/docs/javadoc/< VERSION NUMBER > ../iceberg-docs/javadoc
366
+ cp -r site/docs/javadoc/< VERSION> ../iceberg-docs/javadoc
348
367
```
349
368
350
- This resulted changes in ` iceberg-docs ` should be approved in a separate PR .
369
+ Raise a PR with the specific changes against ` <VERSION> ` branch and merge .
351
370
352
371
#### Update the latest branch
353
372
0 commit comments