You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@bookkeeper.apache.org by GitBox <gi...@apache.org> on 2022/03/03 14:22:38 UTC
[GitHub] [bookkeeper] nicoloboschi opened a new pull request #3081: [website] restore javadoc generation and automate website deployment
nicoloboschi opened a new pull request #3081:
URL: https://github.com/apache/bookkeeper/pull/3081
### Motivation
With gradle the Javadoc generation is not configured well (or at least as it was in maven).
The website is not automatically built with the latest changes. According to https://github.com/apache/bookkeeper/pull/3080 the website deployment will be handled by the ASF infra.
### Changes
* Restored Javadoc configuration from the [maven one](https://github.com/apache/bookkeeper/blob/release-4.13.0/pom.xml#L897)
* Added the javadoc generation to the CI to ensure it will not break
* Added a periodic job (once per day) to build and publish the website (if any changes occur)
--
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@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] eolivelli merged pull request #3081: [website] restore javadoc generation and automate website deployment
Posted by GitBox <gi...@apache.org>.
eolivelli merged pull request #3081:
URL: https://github.com/apache/bookkeeper/pull/3081
--
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@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] nicoloboschi commented on pull request #3081: [website] restore javadoc generation and automate website deployment
Posted by GitBox <gi...@apache.org>.
nicoloboschi commented on pull request #3081:
URL: https://github.com/apache/bookkeeper/pull/3081#issuecomment-1058154191
rerun failure checks
--
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@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] nicoloboschi commented on a change in pull request #3081: [website] restore javadoc generation and automate website deployment
Posted by GitBox <gi...@apache.org>.
nicoloboschi commented on a change in pull request #3081:
URL: https://github.com/apache/bookkeeper/pull/3081#discussion_r818892820
##########
File path: site/scripts/javadoc-gen.sh
##########
@@ -7,18 +7,31 @@ function build_javadoc() {
echo "Building the javadoc for version ${version}."
if [ "$version" == "latest" ]; then
- javadoc_gen_dir="${ROOT_DIR}/target/site/apidocs"
+ javadoc_gen_dir="${ROOT_DIR}/build/docs/javadoc"
+ use_gradle=true
cd $ROOT_DIR
else
- javadoc_gen_dir="/tmp/bookkeeper-${version}/target/site/apidocs"
+
rm -rf /tmp/bookkeeper-${version}
- git clone https://github.com/apache/bookkeeper /tmp/bookkeeper-${version}
+ git clone https://github.com/apache/bookkeeper -b "release-${version}" /tmp/bookkeeper-${version}
cd /tmp/bookkeeper-${version}
- git checkout "release-${version}"
+ if [[ -f "pom.xml" ]]; then
+ use_gradle=false
+ javadoc_gen_dir="/tmp/bookkeeper-${version}/target/site/apidocs"
+ else
+ use_gradle=true
+ javadoc_gen_dir="/tmp/bookkeeper-${version}/build/docs/javadoc"
+ fi
+
fi
javadoc_dest_dir="${ROOT_DIR}/site/docs/${version}/api/javadoc"
rm -rf $javadoc_dest_dir
- mvn clean install javadoc:aggregate -DskipTests
+ if [[ "$use_gradle" == "true" ]]; then
+ ./gradlew generateApiJavadoc
+ else
+ mvn clean install javadoc:aggregate -DskipTests
Review comment:
this script it is intended to also build older bk versions
--
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@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] dlg99 commented on a change in pull request #3081: [website] restore javadoc generation and automate website deployment
Posted by GitBox <gi...@apache.org>.
dlg99 commented on a change in pull request #3081:
URL: https://github.com/apache/bookkeeper/pull/3081#discussion_r818876622
##########
File path: site/scripts/javadoc-gen.sh
##########
@@ -7,18 +7,31 @@ function build_javadoc() {
echo "Building the javadoc for version ${version}."
if [ "$version" == "latest" ]; then
- javadoc_gen_dir="${ROOT_DIR}/target/site/apidocs"
+ javadoc_gen_dir="${ROOT_DIR}/build/docs/javadoc"
+ use_gradle=true
cd $ROOT_DIR
else
- javadoc_gen_dir="/tmp/bookkeeper-${version}/target/site/apidocs"
+
rm -rf /tmp/bookkeeper-${version}
- git clone https://github.com/apache/bookkeeper /tmp/bookkeeper-${version}
+ git clone https://github.com/apache/bookkeeper -b "release-${version}" /tmp/bookkeeper-${version}
cd /tmp/bookkeeper-${version}
- git checkout "release-${version}"
+ if [[ -f "pom.xml" ]]; then
+ use_gradle=false
+ javadoc_gen_dir="/tmp/bookkeeper-${version}/target/site/apidocs"
+ else
+ use_gradle=true
+ javadoc_gen_dir="/tmp/bookkeeper-${version}/build/docs/javadoc"
+ fi
+
fi
javadoc_dest_dir="${ROOT_DIR}/site/docs/${version}/api/javadoc"
rm -rf $javadoc_dest_dir
- mvn clean install javadoc:aggregate -DskipTests
+ if [[ "$use_gradle" == "true" ]]; then
+ ./gradlew generateApiJavadoc
+ else
+ mvn clean install javadoc:aggregate -DskipTests
Review comment:
maven is gone, we can get rid of this and of the code related to "use_gradle"
--
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@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org