Skip to content
This repository was archived by the owner on Feb 6, 2024. It is now read-only.

Commit eea0ba6

Browse files
author
Jack Ye
committed
add more details
1 parent 27cf000 commit eea0ba6

File tree

1 file changed

+43
-24
lines changed

1 file changed

+43
-24
lines changed

landing-page/content/common/how-to-release.md

+43-24
Original file line numberDiff line numberDiff line change
@@ -294,60 +294,79 @@ Thanks to everyone for contributing!
294294

295295
#### Codebase updates
296296

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:
298298
1. https://github.com/apache/iceberg/blob/master/.github/ISSUE_TEMPLATE/iceberg_bug_report.yml
299299
2. https://github.com/apache/iceberg/blob/master/python/dev/Dockerfile
300300
3. `oldVersion` in `revapi` in https://github.com/apache/iceberg/blob/master/build.gradle
301301

302-
### Documentation Release
302+
### Documentation release
303303

304304
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.
309305

310-
#### Common documentation update
306+
#### Prerequisites
311307

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
315316
```
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+
317328
```shell
318-
cd ../iceberg-docs
319-
git checkout -b <BRANCH NAME>
329+
cp -r ../iceberg/format/* ../iceberg-docs/landing-page/content/common/
320330
```
321-
3. Commit, push, and open a PR against the `iceberg-docs` repo (`<BRANCH NAME>` -> `main`)
322331

323-
#### Versioned documentation update
332+
Raise a PR with the specific changes against `main` branch and merge.
333+
334+
#### Create version branch
324335

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:
326337

327-
1. In the `iceberg-docs` repository, cut a new branch using the version number as the branch name
328338
```shell
329-
cd ../iceberg-docs
339+
# sync main to latest first
330340
git checkout -b <VERSION>
331341
git push --set-upstream apache <VERSION>
332342
```
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+
334348
```shell
335349
rm -rf ../iceberg-docs/docs/content
336350
cp -r ../iceberg/docs ../iceberg-docs/docs/content
337351
```
338-
3. Commit the changes and open a PR against the `<VERSION>` branch in the `iceberg-docs` repo
339352

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:
341360

342-
In the `iceberg` repository, generate the javadoc for your release and copy it to the `javadoc` folder in `iceberg-docs` repo:
343361
```shell
344362
cd ../iceberg
363+
echo "<VERSION>" > version.txt
345364
./gradlew refreshJavadoc
346365
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
348367
```
349368

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.
351370

352371
#### Update the latest branch
353372

0 commit comments

Comments
 (0)