Skip to content

Commit

Permalink
Merge pull request geonetwork#23 from juanluisrp/build-web-4
Browse files Browse the repository at this point in the history 
Refactor build script.
Add 4.0.x manuals.
  • Loading branch information
@juanluisrp
juanluisrp authored May 21, 2020
2 parents a1fc0c2 + 8028f99 commit d6c616f
Show file tree
Hide file tree
Showing 2 changed files with 91 additions and 118 deletions.
3 changes: 3 additions & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
target
.idea
docsrc/build
.classpath
.project
.settings
206 changes: 88 additions & 118 deletions checkup_docs.sh
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
#!/bin/bash

export MAVEN_OPTS="-Xmx512M -XX:MaxPermSize=256M"
export MAVEN_OPTS="-Xmx512M"
MAVEN_PROFILES=$1

if [ "$1" == "--help" ]; then
echo "Usage: ./checkup_docs only for basic english version"
echo "Usage: ./checkpu_docs -Platest for English and French using latest translations on Transifex"
echo "Usage: ./checkup_docs -Pall for all languages using cached translations"
echo "Usage: ./checkup_docs -Platest,all for all languages using latest translations on transifex"
echo "Usage: ./checkup_docs -Platest,all for all languages using latest translations on Transifex"
exit 0;
fi

Expand All @@ -16,139 +17,93 @@ tag210='2.10.4'
tagold='3.8.x'
branchold='3.8.x'
current='3.10.x'
pre_release='4.0.x'

###############################################################################
# Clones doc repo, change the branch or tag if it exists and build the
# documents.
#
# Params:
# $1: branch/tag name
#
# Example: build_docs 3.10.x
###############################################################################
function build_docs() {

BRANCH_OR_TAG=$1

# Download from GitHub docs to 'doc_X.Y.Z' folder
echo "=======> Generating docs for $1 branch"
cd $current_dir/target
if [ ! -e "doc_${BRANCH_OR_TAG}" ]; then
echo "==========> No local clone found. Cloning it now"
git clone https://github.com/geonetwork/doc.git doc_${BRANCH_OR_TAG};
echo "==========> Checkout tag/branch ${BRANCH_OR_TAG}"
cd doc_${BRANCH_OR_TAG}
git checkout ${BRANCH_OR_TAG}
else
# If the folder already exists reuse it
echo "==========> Local directory $current_dir/doc${BRANCH_OR_TAG} alredy exists. Skipping git clone command"
cd doc_${BRANCH_OR_TAG};
echo "==========> Checkout tag/branch "${BRANCH_OR_TAG}
git checkout ${BRANCH_OR_TAG}
git pull
fi

echo "=> WEBSITE CREATION STARTED"
git submodule update --init
echo "=======> Build "${BRANCH_OR_TAG}" docs"
mvn -q clean install -DskipTests $MAVEN_PROFILES
echo "=======> "$BRANCH_OR_TAG" manuals created"

}

# -------------------------------------------------------
# GIT ---------------------------------------------------
# -------------------------------------------------------

# Download from GitHub master to 'latest' folder"
echo "=======> Downloading from GitHub master branch to 'latest' folder"

if [ ! -e "latest" ]; then
git clone git://github.com/geonetwork/core-geonetwork.git latest;
else
cd $current_dir/latest;
git pull
fi
echo "=> WEBSITE CREATION STARTED"

cd $current_dir/latest
if git show-ref --quiet refs/heads/master; then
git checkout master
git pull
else
git checkout --track master
fi
git submodule update --init
mkdir -p $current_dir/target

# -------------------------------------------------------
# 2.10.4 branch documentation ---------------------------
# -------------------------------------------------------

# Download from GitHub master to 'core-geonetwork' folder"

# Create folder for 2.10.x branch to '210x' folder
echo "=======> Create folder for 2.10.x branch (tag "$tag210")"
cd $current_dir
if [ ! -e "210x" ]; then
cp -R latest 210x
echo "=======> Generating web for 2.10.x branch (tag "$tag210")"
cd $current_dir/target
if [ ! -e "web_210x" ]; then
echo "=======> Downloading from GitHub Geonetwork branch to 'core-geonetwork' folder"
git clone -b ${tag210} --depth 1 git://github.com/geonetwork/core-geonetwork.git web_210x;
fi
cd $current_dir/210x
echo "==========> Cleanup repository"
git fetch --tags

cd web_210x
#echo "==========> Fetching remote info from repository"
#git fetch --tags
echo "==========> Checkout tag "$tag210
git checkout tags/$tag210
git submodule update --init
git submodule update --init --recursive

echo "=========> Build "$tag210" branch manuals"
echo "=========> Build "$tag210" tag manuals"
# Build website docs for 2.10.x tag
cd docs
mvn -q clean install -DskipTests
mvn clean install -DskipTests
echo "=========> "$tag210" manuals created"

# -------------------------------------------------------
# 3.x.y branch documentation ---------------------------
# -------------------------------------------------------

# Download from GitHub docs to 'doc' folder
echo "=======> Create folder for old stable 3.x.y branch (tag "$tagold")"
cd $current_dir
if [ ! -e "doc"$tagold ]; then
git clone https://github.com/geonetwork/doc.git doc$tagold;
else
echo "==========> Cleanup repository"
cd $current_dir/doc$tagold;
fi

echo "=======> Build "$tagold" branch manuals"
cd $current_dir/doc$tagold
echo "==========> Checkout branch "$branchold
git fetch --tags
if git show-ref --quiet refs/heads/$branchold; then
git checkout $branchold
git pull
else
git checkout --track $branchold
fi
git submodule update --init
echo "=======> Build "$tagold" manuals"
mvn -q clean install $MAVEN_PROFILES
echo "=======> "$branchold" manual created"
cd ..


# Download from GitHub docs to 'doc' folder
echo "=======> Create folder for old stable 3.x.y branch (tag "$current")"
cd $current_dir
if [ ! -e "doc"$current ]; then
git clone https://github.com/geonetwork/doc.git doc$current;
echo "==========> Checkout tag "$current
cd doc$current
git checkout --track $current
else
cd $current_dir/doc$current;
echo "==========> Checkout tag "$current
if git show-ref --quiet refs/heads/$current; then
git checkout $current
else
git checkout --track $current
fi
git pull
fi

echo "=======> Build "$current" branch manuals"
git submodule update --init
echo "=======> Build "$current" manuals"
mvn -q clean install -DskipTests $MAVEN_PROFILES
echo "=======> "$current" manuals created"
cd ..


# -------------------------------------------------------
# Develop branch documentation ---------------------------
# -------------------------------------------------------


# Download from GitHub docs to 'doc' folder
echo "==========> Create folder for stable 3.x.y branch (latest)"
cd $current_dir
if [ ! -e "doc" ]; then
git clone https://github.com/geonetwork/doc.git doc;
else
cd $current_dir/doc;
git pull
fi

echo "=======> Build develop branch manuals"
cd $current_dir/doc
echo "=======> Build latest manuals"
mvn -q clean install -DskipTests $MAVEN_PROFILES
echo "=======> latest manuals created"
build_docs "${tagold}"
build_docs "${current}"
build_docs 'develop'
build_docs "${pre_release}"



# Build geonetwork-opensource website
# -------------------------------------------------------
echo "=> Build website"
echo "=> Building website"

cd $current_dir/docsrc
make clean
Expand All @@ -166,26 +121,41 @@ mkdir -p $current_dir/docsrc/build/html/manuals/$current/fra/users
mkdir -p $current_dir/docsrc/build/html/manuals/trunk/eng/users
mkdir -p $current_dir/docsrc/build/html/manuals/trunk/fra/users

mkdir -p $current_dir/docsrc/build/html/manuals/${pre_release}/eng/users
mkdir -p $current_dir/docsrc/build/html/manuals/${pre_release}/fra/users

# ... Users
cd $current_dir/doc$tagold/target/doc/en/
# 2.10.x
cd $current_dir/target/doc_$tagold/target/doc/en/
cp -R * $current_dir/docsrc/build/html/manuals/$tagold/eng/users
cd $current_dir/doc$tagold/target/doc/fr/
cd $current_dir/target/doc_$tagold/target/doc/fr/
cp -R * $current_dir/docsrc/build/html/manuals/$tagold/fra/users

cd $current_dir/doc$current/target/doc/en/
# 3.x.y
cd $current_dir/target/doc_$current/target/doc/en/
cp -R * $current_dir/docsrc/build/html/manuals/$current/eng/users
cd $current_dir/doc$current/target/doc/fr/
cd $current_dir/target/doc_$current/target/doc/fr/
cp -R * $current_dir/docsrc/build/html/manuals/$current/fra/users

cd $current_dir/doc/target/doc/en/
cd $current_dir/target/doc_develop/target/doc/en/
cp -R * $current_dir/docsrc/build/html/manuals/trunk/eng/users
cd $current_dir/doc/target/doc/fr/
cd $current_dir/target/doc_develop/target/doc/fr/
cp -R * $current_dir/docsrc/build/html/manuals/trunk/fra/users

# 4.x.y
cd $current_dir/target/doc_${pre_release}/target/doc/en/
cp -R * $current_dir/docsrc/build/html/manuals/${pre_release}/eng/users
cd $current_dir/target/doc_${pre_release}/target/doc/fr/
cp -R * $current_dir/docsrc/build/html/manuals/${pre_release}/fra/users

#Copy i18n manuals
cp -R $current_dir/doc$tagold/target/doc/* $current_dir/docsrc/build/html/manuals/$tagold/
cp -R $current_dir/doc$current/target/doc/* $current_dir/docsrc/build/html/manuals/$current/
cp -R $current_dir/doc/target/doc/* $current_dir/docsrc/build/html/manuals/trunk/
cp -R $current_dir/target/doc_$tagold/target/doc/* $current_dir/docsrc/build/html/manuals/$tagold/
cp -R $current_dir/target/doc_$current/target/doc/* $current_dir/docsrc/build/html/manuals/$current/
cp -R $current_dir/target/doc_develop/target/doc/* $current_dir/docsrc/build/html/manuals/trunk/
cp -R $current_dir/target/doc_${pre_release}/target/doc/* $current_dir/docsrc/build/html/manuals/${pre_release}/





# Copy docs to website folder (2.10.x)
Expand All @@ -195,12 +165,12 @@ mkdir -p $current_dir/docsrc/build/html/manuals/$tag210/eng/users
mkdir -p $current_dir/docsrc/build/html/manuals/$tag210/eng/developer

# ... Users
cd $current_dir/210x/docs/eng/users/build
cd $current_dir/target/web_210x/docs/eng/users/build
cp -R html/* $current_dir/docsrc/build/html/manuals/$tag210/eng/users
cp -R latex/GeoNetworkUserManual.pdf $current_dir/docsrc/build/html/manuals/$tag210/eng/users

# ... Developer
cd $current_dir/210x/docs/eng/developer/build
cd $current_dir/target/web_210x/docs/eng/developer/build
cp -R html/* $current_dir/docsrc/build/html/manuals/$tag210/eng/developer
cp -R latex/GeoNetworkDeveloperManual.pdf $current_dir/docsrc/build/html/manuals/$tag210/eng/developer

Expand Down

0 comments on commit d6c616f

Please sign in to comment.