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

Commit e86be32

Browse files
author
Jack Ye
committed
fix more doc release inst
1 parent e91e560 commit e86be32

File tree

1 file changed

+25
-16
lines changed

1 file changed

+25
-16
lines changed

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

+25-16
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@ rm -rf ../iceberg-docs/docs/content
340340
cp -r ../iceberg/docs ../iceberg-docs/docs/content
341341
```
342342

343-
Raise a PR with the specific changes against `<VERSION>` branch and merge.
343+
Raise a PR with the specific changes against `main` branch and merge.
344344

345345
#### Copy versioned Javadoc
346346

@@ -354,20 +354,40 @@ rm -rf ../iceberg-docs/javadoc
354354
cp -r site/docs/javadoc/<VERSION> ../iceberg-docs/javadoc
355355
```
356356

357-
Raise a PR with the specific changes against `<VERSION>` branch and merge.
357+
Raise a PR with the specific changes against `main` branch and merge.
358+
359+
#### Set latest versions
360+
361+
The following fields need to be updated:
362+
1. in `landing-page/config.toml`:
363+
- update `latestVersions.iceberg`
364+
- add one new row in `versions` for the latest version
365+
2. in `docs/config.toml`:
366+
- update `latestVersions.iceberg`
367+
- update `versions.nessie` (check to the version of `org.projectnessie.nessie:*` from [versions.props](https://github.com/apache/iceberg/blob/master/versions.props))
368+
- add one new row in `versions` for the latest version
369+
370+
Raise a PR with the specific changes against `main` branch and merge.
371+
372+
### update release notes
373+
374+
In page `landing-page/content/common/release-notes.md`:
375+
1. Mark the current latest release notes to past releases
376+
2. Add release notes for the new release version
377+
378+
Raise a PR with the specific changes against `main` branch and merge.
358379

359380
#### Create version branch
360381

361382
Create a branch with the specific version number:
362383

363384
```shell
364-
# sync main to latest first
365385
git checkout -b <VERSION>
366386
git push --set-upstream apache <VERSION>
367387
```
368388

369-
#### Update the latest branch
370-
389+
#### Update the `latest` branch
390+
371391
Since `main` is currently the same as the version branch, one needs to rebase `latest` branch against `main`:
372392

373393
```shell
@@ -376,17 +396,6 @@ git rebase main
376396
git push apache latest
377397
```
378398

379-
#### Set latest version in iceberg-docs repo
380-
381-
The last step is to update the `main` branch in `iceberg-docs` to set the latest version.
382-
A PR needs to be published in the `iceberg-docs` repository with the following changes:
383-
1. Update variable `latestVersions.iceberg` to the new release version in `landing-page/config.toml`
384-
2. Update variable `latestVersions.iceberg` to the new release version and
385-
`versions.nessie` to the version of `org.projectnessie.nessie:*` from [versions.props](https://github.com/apache/iceberg/blob/master/versions.props) in `docs/config.toml`
386-
3. Mark the current latest release notes to past releases under `landing-page/content/common/release-notes.md`
387-
4. Add release notes for the new release version in `landing-page/content/common/release-notes.md`
388-
389-
390399
# How to Verify a Release
391400

392401
Each Apache Iceberg release is validated by the community by holding a vote. A community release manager

0 commit comments

Comments
 (0)