rdblue commented on a change in pull request #4105: URL: https://github.com/apache/iceberg/pull/4105#discussion_r806301000
########## File path: docs/common/project/how-to-release.md ########## @@ -60,6 +60,11 @@ To use `gpg` instead of `gpg2`, also set `signing.gnupg.executable=gpg` For more information, see the Gradle [signing documentation](https://docs.gradle.org/current/userguide/signing_plugin.html#sec:signatory_credentials). +### Apache repository + +The release should be executed in the official `https://github.com/apache/iceberg.git` instead of a forked one. +Clone the Apache Iceberg repository or set it as a different origin for release if it is not already set up. Review comment: "origin" should be "remote" right? Origin is typically a specific remote name (your own private fork). ########## File path: docs/common/project/how-to-release.md ########## @@ -255,3 +260,63 @@ Java artifacts are available from Maven Central. Thanks to everyone for contributing! ``` + +### Documentation Release + +Documentation needs to be updated as a part of Iceberg release after a release candidate is passed. +The commands described below assume the `iceberg-docs` repository and `iceberg` repository are in the same parent directory locally, +and the release manager is executing commands in the `iceberg` repository. +Adjust the commands accordingly if it is not the case. + +#### Release notes + +Release notes need to be drafted and published in the `iceberg` repository and reviewed by the community. + +#### Iceberg version update + +Before release, publish a PR in the `iceberg-docs` repository to update `landing-page/config.toml` and `docs/config.toml` to use the new Iceberg version number. + +#### Documentation update + +To start the release process, run the following steps in the `iceberg-docs` repository to copy docs over: + +```shell +rm -rf ../iceberg-docs/docs/content/docs +rm -rf ../iceberg-docs/landing-page/content/common +cp -r docs/versioned ../iceberg-docs/docs/content/docs Review comment: This is where we maintain `latest`? ########## File path: docs/common/project/how-to-release.md ########## @@ -255,3 +260,63 @@ Java artifacts are available from Maven Central. Thanks to everyone for contributing! ``` + +### Documentation Release + +Documentation needs to be updated as a part of Iceberg release after a release candidate is passed. +The commands described below assume the `iceberg-docs` repository and `iceberg` repository are in the same parent directory locally, +and the release manager is executing commands in the `iceberg` repository. +Adjust the commands accordingly if it is not the case. + +#### Release notes + +Release notes need to be drafted and published in the `iceberg` repository and reviewed by the community. + +#### Iceberg version update + +Before release, publish a PR in the `iceberg-docs` repository to update `landing-page/config.toml` and `docs/config.toml` to use the new Iceberg version number. + +#### Documentation update + +To start the release process, run the following steps in the `iceberg-docs` repository to copy docs over: + +```shell +rm -rf ../iceberg-docs/docs/content/docs +rm -rf ../iceberg-docs/landing-page/content/common +cp -r docs/versioned ../iceberg-docs/docs/content/docs +cp -r docs/common ../iceberg-docs/landing-page/content/common Review comment: Is this going to be the case if most pages are maintained in iceberg-docs? Maybe we don't delete common, but copy the spec.md file from iceberg to iceberg-docs. ########## File path: docs/common/project/how-to-release.md ########## @@ -255,3 +260,63 @@ Java artifacts are available from Maven Central. Thanks to everyone for contributing! ``` + +### Documentation Release + +Documentation needs to be updated as a part of Iceberg release after a release candidate is passed. +The commands described below assume the `iceberg-docs` repository and `iceberg` repository are in the same parent directory locally, +and the release manager is executing commands in the `iceberg` repository. +Adjust the commands accordingly if it is not the case. + +#### Release notes + +Release notes need to be drafted and published in the `iceberg` repository and reviewed by the community. + +#### Iceberg version update + +Before release, publish a PR in the `iceberg-docs` repository to update `landing-page/config.toml` and `docs/config.toml` to use the new Iceberg version number. + +#### Documentation update + +To start the release process, run the following steps in the `iceberg-docs` repository to copy docs over: + +```shell +rm -rf ../iceberg-docs/docs/content/docs +rm -rf ../iceberg-docs/landing-page/content/common +cp -r docs/versioned ../iceberg-docs/docs/content/docs +cp -r docs/common ../iceberg-docs/landing-page/content/common +``` + +The resulted changes in `iceberg-docs` should be approved in a separated PR. Review comment: Typo: "separate" rather than "separated" ########## File path: docs/common/project/how-to-release.md ########## @@ -255,3 +260,63 @@ Java artifacts are available from Maven Central. Thanks to everyone for contributing! ``` + +### Documentation Release + +Documentation needs to be updated as a part of Iceberg release after a release candidate is passed. +The commands described below assume the `iceberg-docs` repository and `iceberg` repository are in the same parent directory locally, +and the release manager is executing commands in the `iceberg` repository. +Adjust the commands accordingly if it is not the case. + +#### Release notes + +Release notes need to be drafted and published in the `iceberg` repository and reviewed by the community. + +#### Iceberg version update + +Before release, publish a PR in the `iceberg-docs` repository to update `landing-page/config.toml` and `docs/config.toml` to use the new Iceberg version number. + +#### Documentation update + +To start the release process, run the following steps in the `iceberg-docs` repository to copy docs over: + +```shell +rm -rf ../iceberg-docs/docs/content/docs +rm -rf ../iceberg-docs/landing-page/content/common +cp -r docs/versioned ../iceberg-docs/docs/content/docs +cp -r docs/common ../iceberg-docs/landing-page/content/common +``` + +The resulted changes in `iceberg-docs` should be approved in a separated PR. + +#### Javadoc update + +In the `iceberg` repository, generate the javadoc for your release and copy it to the `javadoc` folder in `iceberg-docs` repo: +```shell +./gradlew refreshJavadoc +rm -rf ../iceberg-docs/javadoc +cp site/docs/javadoc/<VERSION NUMBER> ../iceberg-docs/javadoc +``` + +This resulted changes in `iceberg-docs` should be approved in a separated PR. + +#### Cut a new version branch + +Once completed, go to the `iceberg-docs` repository (the Apache one, not a forked one) to cut a new branch using the version number as the branch name. +For example, to cut a new versioned doc for release `0.13.0`: + +```shell +git checkout -b 0.13.0 +git push --set-upstream origin 0.13.0 Review comment: Is this the right remote? We usually have `apache` as the remote name. ########## File path: docs/common/project/how-to-release.md ########## @@ -255,3 +260,63 @@ Java artifacts are available from Maven Central. Thanks to everyone for contributing! ``` + +### Documentation Release + +Documentation needs to be updated as a part of Iceberg release after a release candidate is passed. +The commands described below assume the `iceberg-docs` repository and `iceberg` repository are in the same parent directory locally, +and the release manager is executing commands in the `iceberg` repository. +Adjust the commands accordingly if it is not the case. + +#### Release notes + +Release notes need to be drafted and published in the `iceberg` repository and reviewed by the community. + +#### Iceberg version update + +Before release, publish a PR in the `iceberg-docs` repository to update `landing-page/config.toml` and `docs/config.toml` to use the new Iceberg version number. + +#### Documentation update + +To start the release process, run the following steps in the `iceberg-docs` repository to copy docs over: + +```shell +rm -rf ../iceberg-docs/docs/content/docs +rm -rf ../iceberg-docs/landing-page/content/common +cp -r docs/versioned ../iceberg-docs/docs/content/docs +cp -r docs/common ../iceberg-docs/landing-page/content/common +``` + +The resulted changes in `iceberg-docs` should be approved in a separated PR. + +#### Javadoc update + +In the `iceberg` repository, generate the javadoc for your release and copy it to the `javadoc` folder in `iceberg-docs` repo: +```shell +./gradlew refreshJavadoc +rm -rf ../iceberg-docs/javadoc +cp site/docs/javadoc/<VERSION NUMBER> ../iceberg-docs/javadoc +``` + +This resulted changes in `iceberg-docs` should be approved in a separated PR. + +#### Cut a new version branch + +Once completed, go to the `iceberg-docs` repository (the Apache one, not a forked one) to cut a new branch using the version number as the branch name. +For example, to cut a new versioned doc for release `0.13.0`: + +```shell +git checkout -b 0.13.0 Review comment: @samredai, I thought just the 0.13.0 docs were in the branch. Is the branch a complete copy of everything in master? ########## File path: docs/common/project/how-to-release.md ########## @@ -255,3 +260,63 @@ Java artifacts are available from Maven Central. Thanks to everyone for contributing! ``` + +### Documentation Release + +Documentation needs to be updated as a part of Iceberg release after a release candidate is passed. +The commands described below assume the `iceberg-docs` repository and `iceberg` repository are in the same parent directory locally, +and the release manager is executing commands in the `iceberg` repository. +Adjust the commands accordingly if it is not the case. + +#### Release notes + +Release notes need to be drafted and published in the `iceberg` repository and reviewed by the community. + +#### Iceberg version update + +Before release, publish a PR in the `iceberg-docs` repository to update `landing-page/config.toml` and `docs/config.toml` to use the new Iceberg version number. + +#### Documentation update + +To start the release process, run the following steps in the `iceberg-docs` repository to copy docs over: + +```shell +rm -rf ../iceberg-docs/docs/content/docs +rm -rf ../iceberg-docs/landing-page/content/common +cp -r docs/versioned ../iceberg-docs/docs/content/docs Review comment: I think I get it. Since this is going to be the basis for the new branch, we put the content directly in the main branch, then branch for the version. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
