Doctor doc scripts adapted to project needs 51/551/6
authorCarlos Goncalves <carlos.goncalves@neclab.eu>
Thu, 14 May 2015 01:53:03 +0000 (03:53 +0200)
committerCarlos Goncalves <carlos.goncalves@neclab.eu>
Thu, 14 May 2015 19:11:07 +0000 (21:11 +0200)
Verification and building scripts have been adapted to serve Doctor
project specific needs. In Doctor we want to build design_docs in HTML
format, and requirement deliverable in HTML and PDF formats. We store
generated files in artifacts.opnfv.org

Jenkins master node may require installation of additional software as
new dependencies are here introduced (sphinx-build, sphinx numfig
extension, make, LaTeX).

JIRA: OCTO-67

Change-Id: Ieedbc3a01ba133575702cc7d5af6cc0bcee8a5d3
Signed-off-by: Carlos Goncalves <carlos.goncalves@neclab.eu>
jjb/doctor/docu-build.sh
jjb/doctor/docu-verify.sh [changed mode: 0644->0755]

index c8f1596..d549506 100644 (file)
@@ -2,62 +2,24 @@
 set -e
 set -o pipefail
 
+design_docs_dir="design_docs"
+build_dir="build"
 project="$(git remote -v | head -n1 | awk '{{print $2}}' | sed -e 's,.*:\(.*/\)\?,,' -e 's/\.git$//')"
 export PATH=$PATH:/usr/local/bin/
 
-git_sha1="$(git rev-parse HEAD)"
-docu_build_date="$(date)"
+make
 
-files=()
-while read -r -d ''; do
-       files+=("$REPLY")
-done < <(find * -type f -iname '*.rst' -print0)
+# upload all built files
+files=(
+    $build_dir/$design_docs_dir
+    $build_dir/requirements/html
+    $build_dir/requirements/latex/*.pdf
+)
 
 for file in "${{files[@]}}"; do
-
-       file_cut="${{file%.*}}"
-       gs_cp_folder="${{file_cut}}"
-
-       # sed part
-       sed -i "s/_sha1_/$git_sha1/g" $file
-       sed -i "s/_date_/$docu_build_date/g" $file
-
-       # rst2html part
-       echo "rst2html $file"
-       rst2html $file | gsutil cp -L gsoutput.txt - \
-       gs://artifacts.opnfv.org/"$project"/"$gs_cp_folder".html
-       gsutil setmeta -h "Content-Type:text/html" \
-                       -h "Cache-Control:private, max-age=0, no-transform" \
-                       gs://artifacts.opnfv.org/"$project"/"$gs_cp_folder".html
-       cat gsoutput.txt
-       rm -f gsoutput.txt
-
-       echo "rst2pdf $file"
-       rst2pdf $file -o - | gsutil cp -L gsoutput.txt - \
-       gs://artifacts.opnfv.org/"$project"/"$gs_cp_folder".pdf
-       gsutil setmeta -h "Content-Type:application/pdf" \
-                       -h "Cache-Control:private, max-age=0, no-transform" \
-                       gs://artifacts.opnfv.org/"$project"/"$gs_cp_folder".pdf
-       cat gsoutput.txt
-       rm -f gsoutput.txt
-
-done
-
-images=()
-while read -r -d ''; do
-        images+=("$REPLY")
-done < <(find * -type f \( -iname \*.jpg -o -iname \*.png \) -print0)
-
-for img in "${{images[@]}}"; do
-
-        # uploading found images
-        echo "uploading $img"
-        cat "$img" | gsutil cp -L gsoutput.txt - \
-        gs://artifacts.opnfv.org/"$project"/"$img"
-        gsutil setmeta -h "Content-Type:image/jpeg" \
-                        -h "Cache-Control:private, max-age=0, no-transform" \
-                        gs://artifacts.opnfv.org/"$project"/"$img"
-        cat gsoutput.txt
-        rm -f gsoutput.txt
-
+    gsutil cp -L gsoutput.txt $file gs://artifacts.opnfv.org/$project/
+    gsutil setmeta -h "Cache-Control:private, max-age=0, no-transform" \
+       gs://artifacts.opnfv.org/$project/$file
+    cat gsoutput.txt
+    rm -f gsoutput.txt
 done
old mode 100644 (file)
new mode 100755 (executable)
index f337a7f..72d02cf
@@ -2,32 +2,6 @@
 set -e
 set -o pipefail
 
-project="$(git remote -v | head -n1 | awk '{{print $2}}' | sed -e 's,.*:\(.*/\)\?,,' -e 's/\.git$//')"
 export PATH=$PATH:/usr/local/bin/
 
-git_sha1="$(git rev-parse HEAD)"
-docu_build_date="$(date)"
-
-files=()
-while read -r -d ''; do
-       files+=("$REPLY")
-done < <(find * -type f -iname '*.rst' -print0)
-
-for file in "${{files[@]}}"; do
-
-       file_cut="${{file%.*}}"
-       gs_cp_folder="${{file_cut}}"
-
-       # sed part
-       sed -i "s/_sha1_/$git_sha1/g" $file
-       sed -i "s/_date_/$docu_build_date/g" $file
-
-       # rst2html part
-       echo "rst2html $file"
-       rst2html $file > $file_cut".html"
-
-       echo "rst2pdf $file"
-       rst2pdf $file -o $file_cut".pdf"
-
-done
-
+make