This is an automated email from the ASF dual-hosted git repository.
zhangduo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hbase.git
The following commit(s) were added to refs/heads/master by this push:
new c5e5d51e044 HBASE-30004 Implement a new generate web site jenkins job
(#7959)
c5e5d51e044 is described below
commit c5e5d51e0447edc844c96bc27849c03fa27fdfb8
Author: Duo Zhang <[email protected]>
AuthorDate: Fri Mar 20 23:29:20 2026 +0800
HBASE-30004 Implement a new generate web site jenkins job (#7959)
Signed-off-by: Dávid Paksy <[email protected]>
---
dev-support/docker/Dockerfile | 1 +
.../build-hbase-website.sh} | 65 +++-------
.../generate-hbase-website.Jenkinsfile | 134 +++++++++++++++++++++
.../generate-hbase-website.Jenkinsfile | 94 ---------------
4 files changed, 149 insertions(+), 145 deletions(-)
diff --git a/dev-support/docker/Dockerfile b/dev-support/docker/Dockerfile
index d5d33987485..294fc272f1c 100644
--- a/dev-support/docker/Dockerfile
+++ b/dev-support/docker/Dockerfile
@@ -57,6 +57,7 @@ RUN DEBIAN_FRONTEND=noninteractive apt-get -qq update && \
shellcheck='0.8.0-*' \
libxml2-dev='2.9.13+dfsg-*' \
libxml2-utils='2.9.13+dfsg-*' \
+ zip='3.0-*' \
&& \
apt-get clean && \
rm -rf /var/lib/apt/lists/* \
diff --git a/dev-support/jenkins-scripts/generate-hbase-website.sh
b/dev-support/generate-website/build-hbase-website.sh
old mode 100644
new mode 100755
similarity index 84%
rename from dev-support/jenkins-scripts/generate-hbase-website.sh
rename to dev-support/generate-website/build-hbase-website.sh
index 2ab7944fc66..4e28ff757de
--- a/dev-support/jenkins-scripts/generate-hbase-website.sh
+++ b/dev-support/generate-website/build-hbase-website.sh
@@ -20,19 +20,6 @@
# This script is meant to run as part of a Jenkins job such as
# https://builds.apache.org/job/hbase_generate_website/
-#
-# It needs to be built on a Jenkins server with the label git-websites
-#
-# Allows specifying options for working directory, maven repo, and publishing
to git
-# run with --help for usage.
-#
-# If there is a build error, the Jenkins job is configured to send an email
-
-declare CURRENT_HBASE_COMMIT
-declare PUSHED
-declare FILE
-declare WEBSITE_COMMIT_MSG
-declare -a FILES_TO_REMOVE
set -e
function usage {
@@ -44,7 +31,6 @@ function usage {
echo " --local-repo /path/for/maven/.m2 Path for putting local maven
repo."
echo " if given must exist."
echo " defaults to making a clean directory
in --working-dir."
- echo " --publish if given, will attempt to push results
back to the hbase-site repo."
echo " --help show this usage message."
exit 1
}
@@ -57,13 +43,11 @@ fi
declare component_dir
declare working_dir
declare local_repo
-declare publish
while [ $# -gt 0 ]
do
case "$1" in
--working-dir) shift; working_dir=$1; shift;;
--local-repo) shift; local_repo=$1; shift;;
- --publish) shift; publish="true";;
--) shift; break;;
-*) usage ;;
*) break;; # terminate while loop
@@ -74,6 +58,12 @@ done
if [ $# -lt 1 ]; then
usage
fi
+
+MVN="mvn"
+if ! command -v mvn &>/dev/null; then
+ MVN=$MAVEN_HOME/bin/mvn
+fi
+
component_dir="$(cd "$(dirname "$1")"; pwd)/$(basename "$1")"
if [ -z "${working_dir}" ]; then
@@ -108,21 +98,10 @@ else
fi
fi
-# Set up the environment
-if [ -z "${JAVA_HOME}" ]; then
- JAVA_HOME="${JDK_1_8_LATEST__HOME}"
- export JAVA_HOME
- export PATH="${JAVA_HOME}/bin:${PATH}"
-fi
-if [ -z "${MAVEN_HOME}" ]; then
- MAVEN_HOME="${MAVEN_3_3_3_HOME}"
- export MAVEN_HOME
- export PATH="${MAVEN_HOME}/bin:${PATH}"
-fi
export MAVEN_OPTS="${MAVEN_OPTS} -Dmaven.repo.local=${local_repo}"
# Verify the Maven version
-mvn -version
+${MVN} -version
# Verify the git version
git --version
@@ -172,13 +151,13 @@ echo "Building HBase"
# breaks for me is hbase-server trying to find hbase-http:test and
hbase-zookeeper:test.
# But! some sunshine: because we're doing a full install before running site,
we can skip all the
# compiling in the forked executions. We have to do it awkwardly because
MJAVADOC-444.
-if mvn \
+if ${MVN} \
--batch-mode \
-Psite-install-step \
--errors \
--log-file="${working_dir}/hbase-install-log-${CURRENT_HBASE_COMMIT}.txt" \
clean install \
- && mvn site \
+ && ${MVN} site \
--batch-mode \
-Dscala.skip=true \
-Psite-build-step \
@@ -193,7 +172,7 @@ fi
# Stage the site
echo "Staging HBase site"
-mvn \
+${MVN} \
--batch-mode \
--errors \
--log-file="${working_dir}/hbase-stage-log-${CURRENT_HBASE_COMMIT}.txt" \
@@ -247,6 +226,10 @@ fi
echo "Adding all the files we know about"
git add .
+if [[ -z "$(git status --porcelain)" ]]; then
+ echo "No files to commit, skipping..."
+ exit 0
+fi
# Create the commit message and commit the changes
WEBSITE_COMMIT_MSG="Published site at $CURRENT_HBASE_COMMIT."
echo "WEBSITE_COMMIT_MSG: $WEBSITE_COMMIT_MSG"
@@ -262,26 +245,6 @@ if [ ! -s "${working_dir}/${CURRENT_HBASE_COMMIT}.patch"
]; then
fi
echo "Change set saved to patch ${working_dir}/${CURRENT_HBASE_COMMIT}.patch"
-if [ -n "${publish}" ]; then
- echo "Publishing changes to remote repo..."
- if git push origin asf-site; then
- echo "changes pushed."
- else
- echo "Failed to push to asf-site. Website not updated."
- exit 1
- fi
- echo "Sending empty commit to work around INFRA-10751."
- git commit --allow-empty -m "INFRA-10751 Empty commit"
- # Push the empty commit
- if git push origin asf-site; then
- echo "empty commit pushed."
- else
- echo "Failed to push the empty commit to asf-site. Website may not update.
Manually push an empty commit to fix this. (See INFRA-10751)"
- exit 1
- fi
- echo "Pushed the changes to branch asf-site. Refresh
http://hbase.apache.org/ to see the changes within a few minutes."
-fi
-
# Zip up the patch so Jenkins can save it
cd "${working_dir}"
zip website.patch.zip "${CURRENT_HBASE_COMMIT}.patch"
diff --git a/dev-support/generate-website/generate-hbase-website.Jenkinsfile
b/dev-support/generate-website/generate-hbase-website.Jenkinsfile
new file mode 100644
index 00000000000..3155fba6d32
--- /dev/null
+++ b/dev-support/generate-website/generate-hbase-website.Jenkinsfile
@@ -0,0 +1,134 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+pipeline {
+ agent {
+ node {
+ label 'hbase'
+ }
+ }
+ triggers {
+ pollSCM('@daily')
+ }
+ options {
+ buildDiscarder(logRotator(numToKeepStr: '30'))
+ timeout (time: 1, unit: 'HOURS')
+ timestamps()
+ skipDefaultCheckout()
+ disableConcurrentBuilds()
+ }
+ parameters {
+ booleanParam(name: 'DEBUG', defaultValue: false, description: 'Produce a
lot more meta-information.')
+ booleanParam(name: 'FORCE_FAIL', defaultValue: false, description: 'force
a failure to test notifications.')
+ }
+ stages {
+ stage ('build hbase website') {
+ steps {
+ dir('component') {
+ checkout scm
+ }
+ sh '''#!/bin/bash -e
+ if [ "${DEBUG}" = "true" ]; then
+ set -x
+ fi
+ if [ "${FORCE_FAIL}" = "true" ]; then
+ false
+ fi
+ user=$(whoami)
+ docker build -t hbase-build-website -f
"${WORKSPACE}/component/dev-support/docker/Dockerfile" .
+ docker run --rm -v "${WORKSPACE}":/home/${user} -v
/etc/passwd:/etc/passwd:ro -v /etc/group:/etc/group:ro \
+ -u `id -u`:`id -g` -e JAVA_HOME="/usr/lib/jvm/java-17" -e
GIT_AUTHOR_NAME="HBase" \
+ -e GIT_AUTHOR_EMAIL="[email protected]" -e
GIT_COMMITTER_NAME="HBase" \
+ -e GIT_COMMITTER_EMAIL="[email protected]"
--workdir=/home/${user} hbase-build-website \
+ "component/dev-support/generate-website/build-hbase-website.sh" \
+ --working-dir /home/${user} component
+ '''
+ script {
+ if (fileExists('website.patch.zip')) {
+ sh'''#!/bin/bash -e
+ patch=$(ls -1 *.patch | head -n 1)
+ echo "Has patch ${patch}, stash and then publish"
+ '''
+ stash name: 'patch', includes: "*.patch"
+ env.PUBLISH_WEBSITE = "true"
+ } else {
+ echo "No patch file, skip stashing and publishing"
+ env.PUBLISH_WEBSITE = "false"
+ }
+ }
+ }
+ }
+ stage('publish hbase website') {
+ agent {
+ node {
+ label 'git-websites'
+ }
+ }
+ when {
+ expression {
+ return env.PUBLISH_WEBSITE == 'true'
+ }
+ }
+ steps {
+ unstash 'patch'
+ sh '''#!/bin/bash -e
+ # wipe out stall repo
+ rm -rf hbase-site
+ git clone --depth 1 --branch asf-site
https://gitbox.apache.org/repos/asf/hbase-site.git
+ patch=$(ls -1 *.patch | head -n 1)
+ cd hbase-site;
+ echo "applying ${patch}"
+ git am ../${patch}
+ echo "Publishing changes to remote repo..."
+ if git push origin asf-site; then
+ echo "changes pushed."
+ else
+ echo "Failed to push to asf-site. Website not updated."
+ exit 1
+ fi
+ echo "Sending empty commit to work around INFRA-10751."
+ git commit --allow-empty -m "INFRA-10751 Empty commit"
+ # Push the empty commit
+ if git push origin asf-site; then
+ echo "empty commit pushed."
+ else
+ echo "Failed to push the empty commit to asf-site. Website may not
update. Manually push an empty commit to fix this. (See INFRA-10751)"
+ exit 1
+ fi
+ echo "Pushed the changes to branch asf-site. Refresh
http://hbase.apache.org/ to see the changes within a few minutes."
+ '''
+ }
+ }
+ }
+ post {
+ always {
+ // Has to be relative to WORKSPACE.
+ archiveArtifacts artifacts: '*.patch.zip,hbase-*.txt'
+ }
+ failure {
+ mail to: '[email protected]', replyTo: '[email protected]',
subject: "Failure: HBase Generate Website", body: """
+Build status: ${currentBuild.currentResult}
+
+The HBase website has not been updated to incorporate recent HBase changes.
+
+See ${env.BUILD_URL}console
+"""
+ }
+ cleanup {
+ deleteDir()
+ }
+ }
+}
diff --git a/dev-support/jenkins-scripts/generate-hbase-website.Jenkinsfile
b/dev-support/jenkins-scripts/generate-hbase-website.Jenkinsfile
deleted file mode 100644
index b9a61272885..00000000000
--- a/dev-support/jenkins-scripts/generate-hbase-website.Jenkinsfile
+++ /dev/null
@@ -1,94 +0,0 @@
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements. See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership. The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License. You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied. See the License for the
-// specific language governing permissions and limitations
-// under the License.
-pipeline {
- agent {
- node {
- label 'git-websites'
- }
- }
- triggers {
- pollSCM('@daily')
- }
- options {
- buildDiscarder(logRotator(numToKeepStr: '30'))
- timeout (time: 1, unit: 'HOURS')
- timestamps()
- skipDefaultCheckout()
- disableConcurrentBuilds()
- }
- parameters {
- booleanParam(name: 'DEBUG', defaultValue: false, description: 'Produce a
lot more meta-information.')
- booleanParam(name: 'FORCE_FAIL', defaultValue: false, description: 'force
a failure to test notifications.')
- }
- stages {
- stage ('generate hbase website') {
- tools {
- maven 'maven_latest'
- // this needs to be set to the jdk that ought to be used to build
releases on the branch the Jenkinsfile is stored in.
- jdk "jdk_17_latest"
- }
- steps {
- dir('hbase') {
- script {
- checkout([
- $class: 'GitSCM',
- branches: [[name: '*/master']],
- doGenerateSubmoduleConfigurations: false,
- extensions: [
- [$class: 'CloneOption',
- noTags: true,
- shallow: true,
- depth: 1
- ],
- [$class: 'CheckoutOption', timeout: 20]
- ],
- userRemoteConfigs: [[url: 'https://github.com/apache/hbase']]
- ])
- }
- }
- sh '''#!/usr/bin/env bash
- set -e
- if [ "${DEBUG}" = "true" ]; then
- set -x
- fi
- if [ "${FORCE_FAIL}" = "true" ]; then
- false
- fi
- bash hbase/dev-support/jenkins-scripts/generate-hbase-website.sh
--working-dir "${WORKSPACE}" --publish hbase
-'''
- }
- }
- }
- post {
- always {
- // Has to be relative to WORKSPACE.
- archiveArtifacts artifacts: '*.patch.zip,hbase-*.txt'
- }
- failure {
- mail to: '[email protected]', replyTo: '[email protected]',
subject: "Failure: HBase Generate Website", body: """
-Build status: ${currentBuild.currentResult}
-
-The HBase website has not been updated to incorporate recent HBase changes.
-
-See ${env.BUILD_URL}console
-"""
- }
- cleanup {
- deleteDir()
- }
- }
-}
