summaryrefslogtreecommitdiffstats
path: root/jjb/scripts
diff options
context:
space:
mode:
Diffstat (limited to 'jjb/scripts')
-rwxr-xr-x[-rw-r--r--]jjb/scripts/publish_docs.sh25
-rwxr-xr-x[-rw-r--r--]jjb/scripts/vpp/docs.sh56
-rwxr-xr-xjjb/scripts/vpp/make-test-docs.sh56
-rw-r--r--jjb/scripts/vpp/sphinx-docs.sh76
4 files changed, 36 insertions, 177 deletions
diff --git a/jjb/scripts/publish_docs.sh b/jjb/scripts/publish_docs.sh
index 86963b68a..841789d82 100644..100755
--- a/jjb/scripts/publish_docs.sh
+++ b/jjb/scripts/publish_docs.sh
@@ -17,6 +17,11 @@ echo "---> publish_docs.sh"
set -exuo pipefail
+if [[ "${SILO}" != "production" ]] ; then
+ echo "WARNING: Doc upload not supported on Jenkins '${SILO}'..."
+ exit 0
+fi
+
CDN_URL="s3-docs.fd.io"
if [[ ${JOB_NAME} == *merge* ]]; then
@@ -33,6 +38,24 @@ if [[ ${JOB_NAME} == *merge* ]]; then
workspace_dir="${WORKSPACE}/resources/tools/doc_gen/_build"
bucket_path="/csit/${GERRIT_BRANCH}/docs/"
;;
+ *"vpp-docs"*)
+ vpp_release="$(${WORKSPACE}/build-root/scripts/version rpm-version)"
+ # TODO: Remove conditional statement when stable/2106 and
+ # stable/2110 are no longer supported
+ if [[ "${vpp_release::2}" -ge "22" ]] ; then
+ workspace_dir="${WORKSPACE}/build-root/docs/html"
+ else
+ workspace_dir="${WORKSPACE}/docs/_build/html"
+ fi
+ bucket_path="/vpp/${vpp_release}/"
+ ;;
+ # TODO: Remove 'vpp-make-test-docs' when stable/2106 and
+ # stable/2110 are no longer supported
+ *"vpp-make-test-docs"*)
+ vpp_release="$(${WORKSPACE}/build-root/scripts/version rpm-version)"
+ workspace_dir="${WORKSPACE}/test/doc/build/html"
+ bucket_path="/vpp/${vpp_release}/vpp_make_test/html/"
+ ;;
*)
die "Unknown job: ${JOB_NAME}"
esac
@@ -48,5 +71,5 @@ if [[ ${JOB_NAME} == *merge* ]]; then
terraform apply -no-color -auto-approve
popd
- echo "S3 docs: <a href=\"https://$CDN_URL/$bucket_path\">https://$CDN_URL/$bucket_path</a>"
+ echo "S3 docs: <a href=\"https://${CDN_URL}${bucket_path}\">https://${CDN_URL}${bucket_path}</a>"
fi
diff --git a/jjb/scripts/vpp/docs.sh b/jjb/scripts/vpp/docs.sh
index 866b32217..ba522b9b6 100644..100755
--- a/jjb/scripts/vpp/docs.sh
+++ b/jjb/scripts/vpp/docs.sh
@@ -22,55 +22,15 @@ line="*************************************************************************"
# the git HEAD id is not the same as the Gerrit New Revision id.
if [[ ${JOB_NAME} == *merge* ]] && [ -n "${GERRIT_NEWREV:-}" ] &&
[ "$GERRIT_NEWREV" != "$GIT_COMMIT" ] ; then
- echo -e "\n$line\nSkipping doxygen docs build. A newer patch has been merged.\n$line\n"
+ echo -e "\n$line\nSkipping docs build. A newer patch has been merged.\n$line\n"
exit 0
fi
-
-DOCS_REPO_URL=${DOCS_REPO_URL:-"https://nexus.fd.io/content/sites/site"}
-PROJECT_PATH=${PROJECT_PATH:-"io/fd/vpp"}
-DOC_FILE=${DOC_FILE:-"vpp.docs.zip"}
-DOC_DIR=${DOC_DIR:-"build-root/docs/html"}
-SITE_DIR=${SITE_DIR:-"build-root/docs/deploy-site"}
-RESOURCES_DIR=${RESOURCES_DIR:-"${SITE_DIR}/src/site/resources"}
-MVN=${MVN:-"/opt/apache/maven/bin/mvn"}
-VERSION=${VERSION:-"$(./build-root/scripts/version rpm-version)"}
-make doxygen
-
-if [[ ${JOB_NAME} == *merge* ]] ; then
- mkdir -p $(dirname ${RESOURCES_DIR})
- mv -f ${DOC_DIR} ${RESOURCES_DIR}
- cd ${SITE_DIR}
- find . -type f '(' -name '*.md5' -o -name '*.dot' -o -name '*.map' ')' -delete
- cat > pom.xml << EOF
- <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
- <modelVersion>4.0.0</modelVersion>
- <groupId>io.fd.vpp</groupId>
- <artifactId>docs</artifactId>
- <version>1.0.0</version>
- <packaging>pom</packaging>
-
- <properties>
- <generateReports>false</generateReports>
- </properties>
-
- <build>
- <extensions>
- <extension>
- <groupId>org.apache.maven.wagon</groupId>
- <artifactId>wagon-webdav-jackrabbit</artifactId>
- <version>2.10</version>
- </extension>
- </extensions>
- </build>
- <distributionManagement>
- <site>
- <id>fdio-site</id>
- <url>dav:${DOCS_REPO_URL}/${PROJECT_PATH}/${VERSION}</url>
- </site>
- </distributionManagement>
- </project>
-EOF
- ${MVN} -B site:site site:deploy -gs "${GLOBAL_SETTINGS_FILE}" -s "${SETTINGS_FILE}" -T 4C
- cd -
+# TODO: Remove conditional statement when stable/2106 and stable/2110 are no
+# longer supported
+vpp_release="$(${WORKSPACE}/build-root/scripts/version rpm-version)"
+if [[ "${vpp_release::2}" -ge "22" ]] ; then
+ CONFIRM=-y FORCE=--force-yes make docs
+else
+ CONFIRM=-y FORCE=--force-yes make docs-venv docs
fi
diff --git a/jjb/scripts/vpp/make-test-docs.sh b/jjb/scripts/vpp/make-test-docs.sh
index 1e390a8b8..0c6e2156d 100755
--- a/jjb/scripts/vpp/make-test-docs.sh
+++ b/jjb/scripts/vpp/make-test-docs.sh
@@ -17,64 +17,16 @@ echo "---> jjb/scripts/vpp/make-test-docs.sh"
set -euxo pipefail
+# TODO: Remove this file when stable/2106 and stable/2110 are no longer
+# supported as 'make test-doc' is deprecated in master (VPP 22.02)
+
line="*************************************************************************"
# Don't build anything if this is a merge job being run when
# the git HEAD id is not the same as the Gerrit New Revision id.
if [[ ${JOB_NAME} == *merge* ]] && [ -n "${GERRIT_NEWREV:-}" ] &&
[ "$GERRIT_NEWREV" != "$GIT_COMMIT" ] ; then
- echo -e "\n$line\nSkipping 'make test' doxygen docs build. A newer patch has been merged.\n$line\n"
+ echo -e "\n$line\nSkipping 'make test' docs build. A newer patch has been merged.\n$line\n"
exit 0
fi
-DOCS_REPO_URL=${DOCS_REPO_URL:-"https://nexus.fd.io/content/sites/site"}
-PROJECT_PATH=${PROJECT_PATH:-"io/fd/vpp"}
-DOC_DIR=${DOC_DIR:-"test/doc/build/html"}
-SITE_DIR=${SITE_DIR:-"build-root/docs/deploy-site"}
-RESOURCES_DIR=${RESOURCES_DIR:-"${SITE_DIR}/src/site/resources/vpp_make_test"}
-MVN=${MVN:-"/opt/apache/maven/bin/mvn"}
-VERSION=${VERSION:-"$(./build-root/scripts/version rpm-version)"}
-
-if [[ ${JOB_NAME} == *2009* ]] || [[ ${JOB_NAME} == *2101* ]] ; then
- DOC_DIR="build-root/build-test/doc/html"
-fi
-
make test-doc
-
-if [[ ${JOB_NAME} == *merge* ]]; then
- mkdir -p ${RESOURCES_DIR}
- mv -f ${DOC_DIR} ${RESOURCES_DIR}
- ls -alR ${RESOURCES_DIR}
- cd ${SITE_DIR}
-
- cat > pom.xml << EOF
- <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
- <modelVersion>4.0.0</modelVersion>
- <groupId>io.fd.vpp</groupId>
- <artifactId>docs</artifactId>
- <version>1.0.0</version>
- <packaging>pom</packaging>
-
- <properties>
- <generateReports>false</generateReports>
- </properties>
-
- <build>
- <extensions>
- <extension>
- <groupId>org.apache.maven.wagon</groupId>
- <artifactId>wagon-webdav-jackrabbit</artifactId>
- <version>2.10</version>
- </extension>
- </extensions>
- </build>
- <distributionManagement>
- <site>
- <id>fdio-site</id>
- <url>dav:${DOCS_REPO_URL}/${PROJECT_PATH}/${VERSION}</url>
- </site>
- </distributionManagement>
- </project>
-EOF
- ${MVN} -B site:site site:deploy -gs "${GLOBAL_SETTINGS_FILE}" -s "${SETTINGS_FILE}" -T 4C
- cd -
-fi
diff --git a/jjb/scripts/vpp/sphinx-docs.sh b/jjb/scripts/vpp/sphinx-docs.sh
deleted file mode 100644
index d80b4cd38..000000000
--- a/jjb/scripts/vpp/sphinx-docs.sh
+++ /dev/null
@@ -1,76 +0,0 @@
-#!/bin/bash
-
-# Copyright (c) 2021 Cisco and/or its affiliates.
-# Licensed 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.
-
-echo "---> jjb/scripts/vpp/sphinx-docs.sh"
-
-set -euxo pipefail
-
-line="*************************************************************************"
-# Don't build anything if this is a merge job being run when
-# the git HEAD id is not the same as the Gerrit New Revision id.
-if [[ ${JOB_NAME} == *merge* ]] && [ -n "${GERRIT_NEWREV:-}" ] &&
- [ "$GERRIT_NEWREV" != "$GIT_COMMIT" ] ; then
- echo -e "\n$line\nSkipping sphinx docs build. A newer patch has been merged.\n$line\n"
- exit 0
-fi
-
-DOCS_REPO_URL=${DOCS_REPO_URL:-"https://nexus.fd.io/content/sites/site"}
-PROJECT_PATH=${PROJECT_PATH:-"io/fd/vpp"}
-DOC_FILE=${DOC_FILE:-"vpp.docs.zip"}
-DOC_DIR=${DOC_DIR:-"./docs/_build/html"}
-SITE_DIR=${SITE_DIR:-"build-root/docs/deploy-site"}
-RESOURCES_DIR=${RESOURCES_DIR:-"${SITE_DIR}/src/site/resources"}
-MVN=${MVN:-"/opt/apache/maven/bin/mvn"}
-VERSION=${VERSION:-"$(./build-root/scripts/version rpm-version)"}
-
-make docs-venv
-CONFIRM=-y FORCE=--force-yes make docs
-
-if [[ ${JOB_NAME} == *merge* ]]; then
- mkdir -p $(dirname ${RESOURCES_DIR})
- mv -f ${DOC_DIR} ${RESOURCES_DIR}
- cd ${SITE_DIR}
- cat > pom.xml << EOF
- <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
- <modelVersion>4.0.0</modelVersion>
- <groupId>io.fd.vpp</groupId>
- <artifactId>docs</artifactId>
- <version>1.0.0</version>
- <packaging>pom</packaging>
-
- <properties>
- <generateReports>false</generateReports>
- </properties>
-
- <build>
- <extensions>
- <extension>
- <groupId>org.apache.maven.wagon</groupId>
- <artifactId>wagon-webdav-jackrabbit</artifactId>
- <version>2.10</version>
- </extension>
- </extensions>
- </build>
- <distributionManagement>
- <site>
- <id>fdio-site</id>
- <url>dav:${DOCS_REPO_URL}/${PROJECT_PATH}/v${VERSION}</url>
- </site>
- </distributionManagement>
- </project>
-EOF
- ${MVN} -B site:site site:deploy -gs "${GLOBAL_SETTINGS_FILE}" -s "${SETTINGS_FILE}" -T 4C
- cd -
-fi