You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@iceberg.apache.org by "stevenzwu (via GitHub)" <gi...@apache.org> on 2025/09/13 05:00:55 UTC
[PR] Infra: update how-to-release doc and site scripts on releasing versioned doc and javadoc based on learnings from 1.10.0 release [iceberg]
stevenzwu opened a new pull request, #14066:
URL: https://github.com/apache/iceberg/pull/14066
(no comment)
--
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: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] Infra: update how-to-release doc and site scripts on releasing versioned doc and javadoc based on learnings from 1.10.0 release [iceberg]
Posted by "stevenzwu (via GitHub)" <gi...@apache.org>.
stevenzwu merged PR #14066:
URL: https://github.com/apache/iceberg/pull/14066
--
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: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] Infra: update how-to-release doc and site scripts on releasing versioned doc and javadoc based on learnings from 1.10.0 release [iceberg]
Posted by "stevenzwu (via GitHub)" <gi...@apache.org>.
stevenzwu commented on code in PR #14066:
URL: https://github.com/apache/iceberg/pull/14066#discussion_r2345904185
##########
site/dev/common.sh:
##########
@@ -69,7 +69,7 @@ install_deps () {
echo " --> install deps"
# Use pip to install or upgrade dependencies from the 'requirements.txt' file quietly
- pip -q install -r requirements.txt --upgrade
+ pip3 -q install -r requirements.txt --upgrade
Review Comment:
`pip3` probably works better for most env.
`python3` is also used at line 204
--
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: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] Infra: update how-to-release doc and site scripts on releasing versioned doc and javadoc based on learnings from 1.10.0 release [iceberg]
Posted by "huaxingao (via GitHub)" <gi...@apache.org>.
huaxingao commented on code in PR #14066:
URL: https://github.com/apache/iceberg/pull/14066#discussion_r2347728976
##########
site/dev/deploy.sh:
##########
@@ -18,6 +18,10 @@
set -e
+remote_name="${1:apache}"
Review Comment:
should this be `remote_name="${1:-apache}"`?
--
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: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] Infra: update how-to-release doc and site scripts on releasing versioned doc and javadoc based on learnings from 1.10.0 release [iceberg]
Posted by "kevinjqliu (via GitHub)" <gi...@apache.org>.
kevinjqliu commented on code in PR #14066:
URL: https://github.com/apache/iceberg/pull/14066#discussion_r2349686391
##########
site/README.md:
##########
@@ -145,9 +145,12 @@ Deploying the docs is a two-step process:
```sh
make release ICEBERG_VERSION=${ICEBERG_VERSION}
```
- 1. Build and push the generated site to `asf-site`.
+ 1. Build and push the generated site to the `asf-site` branch of [remote repo](https://github.com/apache/iceberg). This requires committer write permission.
```sh
- make deploy
+ # Default remote name is 'apache'
+ make deploy
+ # Or specify a different remote
+ make deploy remote_name=apache
Review Comment:
https://www.mkdocs.org/user-guide/configuration/#remote_name
otherwise, the origin name is default to `origin`
I use to have the apache/iceberg repo as `origin`, but now its `apache`. This change makes it configurable 👍
--
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: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] Infra: update how-to-release doc and site scripts on releasing versioned doc and javadoc based on learnings from 1.10.0 release [iceberg]
Posted by "stevenzwu (via GitHub)" <gi...@apache.org>.
stevenzwu commented on code in PR #14066:
URL: https://github.com/apache/iceberg/pull/14066#discussion_r2350392674
##########
site/dev/deploy.sh:
##########
@@ -18,6 +18,10 @@
set -e
+remote_name="${1:-apache}"
+
./dev/setup_env.sh
-mkdocs gh-deploy --no-history --remote-branch=asf-site
+echo " --> Deploy to asf-site branch of remote repository: ${remote_name}"
+
+mkdocs gh-deploy --no-history --remote-branch=asf-site --remote-name ${remote_name}
Review Comment:
The intention of `--no-history` is probably to reduce the size of git history. Javadoc can contain a lot of files.
I will skip this change in this PR.
--
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: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] Infra: update how-to-release doc and site scripts on releasing versioned doc and javadoc based on learnings from 1.10.0 release [iceberg]
Posted by "stevenzwu (via GitHub)" <gi...@apache.org>.
stevenzwu commented on code in PR #14066:
URL: https://github.com/apache/iceberg/pull/14066#discussion_r2345904688
##########
site/docs/how-to-release.md:
##########
@@ -324,7 +324,7 @@ Create a PR in the `iceberg` repo to make revapi run on the new release. For an
### Documentation Release
-Please follow the instructions on the GitHub repository in the [`README.md` in the `site/`](https://github.com/apache/iceberg/tree/main/site) directory.
Review Comment:
this deploy/release step should be executed after the doc and javadoc branches are updated/pushed first. moved it to the proper order later.
--
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: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] Infra: update how-to-release doc and site scripts on releasing versioned doc and javadoc based on learnings from 1.10.0 release [iceberg]
Posted by "kevinjqliu (via GitHub)" <gi...@apache.org>.
kevinjqliu commented on code in PR #14066:
URL: https://github.com/apache/iceberg/pull/14066#discussion_r2349668805
##########
site/docs/how-to-release.md:
##########
@@ -324,7 +324,7 @@ Create a PR in the `iceberg` repo to make revapi run on the new release. For an
### Documentation Release
-Please follow the instructions on the GitHub repository in the [`README.md` in the `site/`](https://github.com/apache/iceberg/tree/main/site) directory.
+
#### Versioned Docs
Review Comment:
nit:
```suggestion
#### Generate Versioned Docs
```
--
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: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] Infra: update how-to-release doc and site scripts on releasing versioned doc and javadoc based on learnings from 1.10.0 release [iceberg]
Posted by "huaxingao (via GitHub)" <gi...@apache.org>.
huaxingao commented on code in PR #14066:
URL: https://github.com/apache/iceberg/pull/14066#discussion_r2347734576
##########
site/dev/deploy.sh:
##########
@@ -18,6 +18,10 @@
set -e
+remote_name="${1:apache}"
+
./dev/setup_env.sh
-mkdocs gh-deploy --no-history --remote-branch=asf-site
+echo " --> Deploy to asf-site branch of remote repository: ${remote_name}"
+
+mkdocs gh-deploy --no-history --remote-branch=asf-site --remote-name apache
Review Comment:
pass the defined `${remote_name}` instead of `apache`?
--
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: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] Infra: update how-to-release doc and site scripts on releasing versioned doc and javadoc based on learnings from 1.10.0 release [iceberg]
Posted by "kevinjqliu (via GitHub)" <gi...@apache.org>.
kevinjqliu commented on code in PR #14066:
URL: https://github.com/apache/iceberg/pull/14066#discussion_r2349668805
##########
site/docs/how-to-release.md:
##########
@@ -324,7 +324,7 @@ Create a PR in the `iceberg` repo to make revapi run on the new release. For an
### Documentation Release
-Please follow the instructions on the GitHub repository in the [`README.md` in the `site/`](https://github.com/apache/iceberg/tree/main/site) directory.
+
#### Versioned Docs
Review Comment:
```suggestion
#### Generate Versioned Docs
```
##########
site/docs/how-to-release.md:
##########
@@ -324,7 +324,7 @@ Create a PR in the `iceberg` repo to make revapi run on the new release. For an
### Documentation Release
-Please follow the instructions on the GitHub repository in the [`README.md` in the `site/`](https://github.com/apache/iceberg/tree/main/site) directory.
+
#### Versioned Docs
Review Comment:
`Versioned Javadoc` -> `Generate Versioned Javadoc`
`Versioned docs and javadoc release` -> ` Release Versioned Docs and Javadoc`
--
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: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] Infra: update how-to-release doc and site scripts on releasing versioned doc and javadoc based on learnings from 1.10.0 release [iceberg]
Posted by "kevinjqliu (via GitHub)" <gi...@apache.org>.
kevinjqliu commented on code in PR #14066:
URL: https://github.com/apache/iceberg/pull/14066#discussion_r2349679327
##########
site/dev/deploy.sh:
##########
@@ -18,6 +18,10 @@
set -e
+remote_name="${1:-apache}"
+
./dev/setup_env.sh
-mkdocs gh-deploy --no-history --remote-branch=asf-site
+echo " --> Deploy to asf-site branch of remote repository: ${remote_name}"
+
+mkdocs gh-deploy --no-history --remote-branch=asf-site --remote-name ${remote_name}
Review Comment:
maybe we can take out `--no-history` here.
its confusing to not have history for the asf-site branch https://github.com/apache/iceberg/tree/asf-site
--
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: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] Infra: update how-to-release doc and site scripts on releasing versioned doc and javadoc based on learnings from 1.10.0 release [iceberg]
Posted by "stevenzwu (via GitHub)" <gi...@apache.org>.
stevenzwu commented on code in PR #14066:
URL: https://github.com/apache/iceberg/pull/14066#discussion_r2350387867
##########
site/docs/how-to-release.md:
##########
@@ -324,7 +324,7 @@ Create a PR in the `iceberg` repo to make revapi run on the new release. For an
### Documentation Release
-Please follow the instructions on the GitHub repository in the [`README.md` in the `site/`](https://github.com/apache/iceberg/tree/main/site) directory.
+
#### Versioned Docs
Review Comment:
updated
--
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: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org