diff options
6 files changed, 515 insertions, 0 deletions
diff --git a/jjb/daily-jjb-doc-multiversion-update/daily-jjb-doc-multiversion-update.local.sh b/jjb/daily-jjb-doc-multiversion-update/daily-jjb-doc-multiversion-update.local.sh new file mode 100755 index 00000000..e0fc9ea7 --- /dev/null +++ b/jjb/daily-jjb-doc-multiversion-update/daily-jjb-doc-multiversion-update.local.sh @@ -0,0 +1,50 @@ +#!/bin/bash + +set -e + +# make sure 'node' is in path (debian calls it nodejs) +mkdir -p bin +ln -sf /usr/bin/nodejs bin/node +export PATH=$PATH:`pwd`/bin + +[[ -z "$WORKSPACE" ]] && WORKSPACE=$(pwd -P) +HTDOCS=${HTDOCS:-$WORKSPACE/htdocs} + +. include-doc-multiversion-update.sh + +( sleep 7 ; firefox http://127.0.0.1:8000 ) & + +cd $HTDOCS + +node <<EOF +// from https://gist.github.com/ryanflorence/701407 +["http","url","path","fs"].forEach(m => {global[m] = require(m);} ); +var port=process.argv[2] || 8000; + +http.createServer(function(request, response) { + var uri=url.parse(request.url).pathname; + var filename=path.join(process.cwd(), uri); + fs.exists(filename,function(exists) { + if(!exists) { + response.writeHead(404, {"Content-Type": "text/plain"}); + response.write("404 Not Found\n"); + response.end(); + return; + } + if (fs.statSync(filename).isDirectory()) filename+='/index.html'; + fs.readFile(filename,"binary",function(err, file) { + if(err) { + response.writeHead(500,{"Content-Type": "text/plain"}); + response.write(err+"\n"); + response.end(); + return; + } + response.writeHead(200); + response.write(file,"binary"); + response.end(); + }); + }); +}).listen(parseInt(port,10)); +console.log("Static file server running at\n => http://localhost:" + port + "/\nCTRL + C to shutdown"); +EOF + diff --git a/jjb/daily-jjb-doc-multiversion-update/daily-jjb-doc-multiversion-update.yaml b/jjb/daily-jjb-doc-multiversion-update/daily-jjb-doc-multiversion-update.yaml new file mode 100644 index 00000000..4c0c0736 --- /dev/null +++ b/jjb/daily-jjb-doc-multiversion-update/daily-jjb-doc-multiversion-update.yaml @@ -0,0 +1,32 @@ +--- +- project: + name: daily-jjb-doc-multiversion + jobs: + - daily-jjb-doc-multiversion-update + +- job-template: + name: 'daily-jjb-doc-multiversion-update' + project-type: freestyle + concurrent: false + node: agl-test-slave + description: "Managed by JJB. Do not Edit. \ + <br>Build time graph:<br><img src='buildTimeGraph/png' />" + + build-discarder: + days-to-keep: 30 + num-to-keep: 40 + artifact-days-to-keep: -1 + artifact-num-to-keep: 5 + + triggers: + - timed: '@daily' + + wrappers: + - agl-infra-wrappers: + build-timeout: '{build-timeout}' + + builders: + - shell: + !include-raw-escape: include-doc-multiversion-update.sh + - shell: + !include-raw-escape: include-doc-multiversion-upload.sh diff --git a/jjb/daily-jjb-doc-multiversion-update/include-doc-multiversion-update.sh b/jjb/daily-jjb-doc-multiversion-update/include-doc-multiversion-update.sh new file mode 100644 index 00000000..cb2cef74 --- /dev/null +++ b/jjb/daily-jjb-doc-multiversion-update/include-doc-multiversion-update.sh @@ -0,0 +1,267 @@ +#!/bin/bash +set -e + +# make sure 'node' is in path (debian calls it nodejs) +mkdir -p bin +ln -sf /usr/bin/nodejs bin/node +export PATH=$PATH:`pwd`/bin + +[[ -z "$WORKSPACE" ]] && WORKSPACE=$(pwd -P) +echo "Using workspace $WORKSPACE" +TMPDIR=${TMPDIR:-$WORKSPACE/docs-webtemplate} +HTDOCS=${HTDOCS:-$WORKSPACE/htdocs} +mkdir -p $HTDOCS + +trap "rm -rf $WORKSPACE/setupdocs.sh $TMPDIR" STOP INT QUIT EXIT + +# setupdocs is already imported from automotive-grade-linux/docs-webtemplate +#wget -O $WORKSPACE/setupdocs.sh https://raw.githubusercontent.com/automotive-grade-linux/docs-webtemplate/master/setupdocs.sh +chmod +x $WORKSPACE/setupdocs.sh + +function gensite() { + local branch=${1:-master} + local tmp=$TMPDIR/$branch + + mkdir -p $tmp + + $WORKSPACE/setupdocs.sh -w master -d $tmp + + pushd $tmp + + tocsdir="tocs_$branch" + # exception for master branch to keep aligned with legacy tocs_agl + [[ "$branch" == "master" ]] && tocsdir="tocs" + + sed -i "s|^baseurl:.*$|baseurl: \"/$branch\"|g" conf/_dev.yml + sed -i "s|^docsurl:.*$|docsurl: \"/$branch/docs\"|g" conf/_config.yml + cat <<-EOF >>conf/AppDefaults.js + config.TOCS_DIR="$PWD/content/$tocsdir"; + config.AGL_GERRIT_BRANCH="$branch"; + config.AGL_GITHUB_BRANCH="$branch"; + EOF + + navbarColor="#222" + typeDocStr="master branch" + if [ "$branch" == "flounder" ]; then + navbarColor="darkslategray" + typeDocStr="Flounder release" + fi + + git apply <<EOF +diff --git a/site/_includes/header.html b/site/_includes/header.html +index 6828472..26035b0 100644 +--- a/site/_includes/header.html ++++ b/site/_includes/header.html +@@ -1,9 +1,9 @@ + <header> + <a class="scroll-point pt-top" name="top"></a> +- <nav class="navbar navbar-inverse navbar-fixed-top"> ++ <nav class="navbar navbar-inverse navbar-fixed-top" style="background-color: ${navbarColor};"> + <div class="container-fluid"> + <div class="navbar-header"> +- <a class="navbar-brand" href="{{ site.baseurl }}/"><img id="logo_top" src="{{ site.baseurl }}{{ site.logo.navbar }}"/></a> ++ <a class="navbar-brand" href="/"><img id="logo_top" src="{{ site.baseurl }}{{ site.logo.navbar }}"/></a> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> +@@ -35,6 +35,13 @@ + </li> + </ul> + </div> ++ <div class="nav_bar_center"> ++ <ul class="nav navbar-nav" style="margin-left: 5%;"> ++ <li> ++ <a style="color:red;"><b>${typeDocStr} documentation</b></a> ++ </li> ++ </ul> ++ </div> + <div class="nav_bar_right"> + <ul class="nav navbar-nav"> + {% comment %} <!-- disabled because posts are not updated - see SPEC-2029 --> +EOF + + make build + rsync -Pav --delete build-dev/ $HTDOCS/$branch/ + + popd +} + +gensite master +gensite flounder + +# front page +echo "Generating front page in $HTDOCS/index.html" +cat <<EOF >$HTDOCS/index.html +<html lang="en"> +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> + <meta name="format-detection" content="telephone=no"> + <meta name="viewport" content="user-scalable=no, initial-scale=1, maximum-scale=1, minimum-scale=1, width=device-width"> + <meta name="description" content=" "> + <title>AGL Documentation Site</title> + <link rel="SHORTCUT ICON" href="/master/favicon.ico"> + <link rel="canonical" href="http://docs.automotivelinux.org/"> + <!-- CSS --> + <link rel="stylesheet" type="text/css" href="/master/static/styles/main.css"> + <link rel="stylesheet" type="text/css" href="/master/static/styles/syntax.css"> + <!-- Fonts --> + <!-- For attribution information, see www/attributions.html --> + <link href="https://fonts.googleapis.com/css?family=Raleway:700,400,300,700italic,400italic,300italic" rel="stylesheet" + type="text/css"> + <!-- JS --> + <script async="" src="//www.google-analytics.com/analytics.js"></script> + <script defer="" type="text/javascript" src="/master/static/js/lib/jquery-2.1.1.min.js"></script> + <script defer="" type="text/javascript" src="/master/static/js/lib/bootstrap.min.js"></script> + <script> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + ga('create', '', 'auto'); + ga('send', 'pageview'); + </script> +</head> + +<style> +#hero { + display: flex; +} +#hero #hero_section { + margin: auto; + font-size: 25px; +} +#hero #hero_section > div { + display: flex; + justify-content: center; +} +</style> + +<body> + <header> + <a class="scroll-point pt-top" name="top"></a> + <nav class="navbar navbar-inverse navbar-fixed-top"> + <div class="container-fluid"> + <div class="navbar-header"> + <a class="navbar-brand" href="/"><img id="logo_top" src="/master/static/img/branding/agl_title_793x211.png" /></a> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" + aria-expanded="false" aria-controls="navbar"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + </div> + </div> + <!--/.navbar-collapse --> + </nav> + <div id="_fixed_navbar_spacer" style="padding-top:50px"></div> + </header> + <div id="hero"> + <div id="hero_section"> + <div> + <p>Welcome to AGL documentation website</p> + </div> + <div> + <p><em>Please select the documentation version :</em></p> + </div> + + <div class="hero_buttons"> + <a href="/master" class="col-xs-12 col-sm-5 btn btn-lg btn-primary" style="margin: auto;">Master (Development)</a> + <a href="/flounder" class="col-xs-12 col-sm-5 btn btn-lg btn-primary">Flounder (AGL 6.x)</a> + </div> + </div> + </div> + <div class="blue-divider"></div> + <footer> + <div class="container"> + <div class="row"> + <div class="col-sm-9"> + <h1>More Resources</h1> + <div class="row"> + <div class="col-sm-4"> + <h2>General</h2> + <ul class="nav"> + <li> + <a target="_blank" href="https://www.automotivelinux.org/">AGL Developer Community</a> + </li> + <li> + <a href="https://www.automotivelinux.org/software/download/">Download Distribution</a> + </li> + <li> + <a href="https://gerrit.automotivelinux.org/gerrit/#/admin/projects/">Source Code on Git</a> + </li> + <li> + <a target="_blank" href="http://lists.linuxfoundation.org/mailman/listinfo/automotive-discussions">Mailing List</a> + </li> + </ul> + </div> + <div class="col-sm-4"> + <h2>Development</h2> + <ul class="nav"> + <li><a target="_blank" href="https://wiki.automotivelinux.org/agl-distro/source-code">Source + Code</a></li> + <li><a target="_blank" href="https://jira.automotivelinux.org/browse/SPEC/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel">Issue + Tracker</a></li> + <li><a target="_blank" href="https://wiki.automotivelinux.org/">Wiki</a></li> + <li><a href="https://www.automotivelinux.org/contact">Contact</a></li> + </ul> + </div> + <div class="col-sm-4"> + <h2>Automotive Grade Linux @ Linux Foundation</h2> + <ul class="nav"> + <li> + <a target="_blank" href="https://www.automotivelinux.org/">About AGL</a> + </li> + <li> + <a target="_blank" href="http://www.linuxfoundation.org/">About Linux Foundation</a> + </li> + <li> + <a target="_blank" href="https://wiki.automotivelinux.org/start/getting-started">Join AGL + community</a> + </li> + <li> + <a target="_blank" href="https://www.automotivelinux.org/about/members">Members</a> + </li> + </ul> + </div> + </div> + </div> + <div class="col-sm-3"> + <h1>Contribute</h1> + <p style="padding-top:20px"><strong>Help AGL move forward!</strong></p> + <p>Report bugs, improve the docs, or contribute to the code.</p> + <a href="/master/contribute" class="btn btn-lg btn-primary"> + Learn More + </a> + <p style="padding-top:20px"> <a href="https://twitter.com/autogradelinux" class="twitter-follow-button" + data-show-count="false">Follow @autogradelinux</a></p> + </div> + </div> + <div class="row"> + <div class="col-sm-9"> + <p class="copyright_text"> + Copyright © 2015-2018 Automotive Grade Linux Documentation, Licensed under the <a target="_blank" + href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>. + <br /> + Automotive Grade Linux and logos are <a target="_blank" href="http://www.linuxfoundation.org">trademarks</a> + of The Linux Foundation. + <br /> + Initial site design from <a href="https://cordova.apache.org/">Cordova website.</a> - warm thanks ! + </p> + </div> + <div class="col-sm-3"> + <small class="stats">Site rendered at: $(date --rfc-3339=seconds -u)</small> + + </div> + </div> + + </div> + </footer> +</body> + +</html> +EOF + +echo "Doc site is now available in $HTDOCS" diff --git a/jjb/daily-jjb-doc-multiversion-update/include-doc-multiversion-upload.sh b/jjb/daily-jjb-doc-multiversion-update/include-doc-multiversion-upload.sh new file mode 100644 index 00000000..5c505d23 --- /dev/null +++ b/jjb/daily-jjb-doc-multiversion-update/include-doc-multiversion-upload.sh @@ -0,0 +1,21 @@ +#!/bin/bash +set -e + +[[ -z "$WORKSPACE" ]] && WORKSPACE=$(pwd -P) +HTDOCS=${HTDOCS:-$WORKSPACE/htdocs} +TMPDIR=${TMPDIR:-$WORKSPACE/upload-gh} + +# publish the docs + +mkdir -p $TMPDIR +git clone -b gh-pages git@github.com:automotive-grade-linux/docs-gh-pages.git $TMPDIR/upload-gh-pages +cp -ar $HTDOCS/* $TMPDIR/upload-gh-pages/ +pushd $TMPDIR/upload-gh-pages + git config user.name build.automotivelinux.org + git config user.email jenkins@automotivelinux.org + git diff + git add . + git commit --amend -m"Render: $(date)" + git push origin gh-pages:gh-pages -f +popd + diff --git a/jjb/daily-jjb-doc-multiversion-update/setupdocs.sh b/jjb/daily-jjb-doc-multiversion-update/setupdocs.sh new file mode 100755 index 00000000..dc276b69 --- /dev/null +++ b/jjb/daily-jjb-doc-multiversion-update/setupdocs.sh @@ -0,0 +1,143 @@ +#!/bin/bash + +DEBUG=1 +PROGNAME=$(basename $BASH_SOURCE) +DESTINATION="." +GITREF="" +DOCTOOLSDIR="doctools" +docswebtemplates="https://github.com/automotive-grade-linux/docs-webtemplate.git" +doctools="https://github.com/automotive-grade-linux/docs-tools.git" + +#default branch +ref_docswebtemplate="" +ref_doctools="master" + +pushd() { + command pushd "$@" &> /dev/null +} +popd() { + command popd "$@" &> /dev/null +} +debug() { + [[ $DEBUG -eq 0 ]] && echo "[DEBUG]: $@" >&2 +} +error() { + echo "$@" >&2 +} + +gitcheckout() { + command git checkout "$@" &> /dev/null + if [ ! $? -eq 0 ]; then + error "Cannot checkout: $@ does not exit" + exit 4 + fi +} + +gitclone() { + command git clone "$@" &> /dev/null + if [ ! $? -eq 0 ]; then + error "Cannot clone $@ " + exit 5 + fi +} + +function usage() { + cat <<EOF >&2 +Usage: $PROGNAME [OPTIONS]... [DIRECTORY] + --debug debug mode + -d, --directory=[DST] directory destination; DST is the destination + -h, --help print this help + -t, --doctools-ref=[REFERENCE] doctools reference; + REFERENCE can be a branch, a tag, a commit + -w, --webtemplate-ref=[REFERENCE] webtemplates reference; + REFERENCE can be a branch, a tag, a commit +EOF + exit 1 +} + + +SHORTOPTS="w:t:d:h" +LONGOPTS="webtemplate-ref:,doctools-ref:,directory:,debug,help" +ARGS=$(getopt -s bash --options $SHORTOPTS \ + --longoptions $LONGOPTS --name $PROGNAME -- "$@" ) +if [ ! $? -eq 0 ]; then + exit 1 +fi +eval set -- "$ARGS" + +while [ "$#" -gt "1" ]; do + case "$1" in + -w|--webtemplate-ref) + ref_docswebtemplate=$2;shift 2;; + -t|--doctools-ref) + ref_doctools=$2; shift 2;; + -d|--directory) + DESTINATION=$2;shift 2;; + --debug) + DEBUG=0;shift 2;; + -h|--help) + usage;; + *) + usage;; + esac +done + +#make sure nodejs and jekyll are installed +node -v && jekyll -v +if [ ! $? -eq 0 ]; then + error "please, make sure nodejs and jekyll are installed" + exit 3 +fi + +#check writable dir +if [ ! -w $DESTINATION ]; then + error "$DESTINATION is not a writable directory" + exit 2 +fi + + +pushd $DESTINATION + +#get reference +[[ -d .git ]] && [[ "$(realpath $BASH_SOURCE)" == "$(realpath $(basename $BASH_SOURCE))" ]] && GITREF=$(git rev-parse HEAD) +ref_docswebtemplate=${ref_docswebtemplate:-${GITREF:-master}} +debug "ref_docswebtemplate=$ref_docswebtemplate ref_doctools=$ref_doctools" + +[[ -d .git ]] && rev=$(git show-ref -s $ref_docswebtemplate | sort | uniq) && rev=${rev:-$ref_docswebtemplate} + +debug "GITREF=$GITREF and rev=$rev" +#check that reference given matching with local repo +[[ "$GITREF" != "$rev" ]] \ + && { error "Invalid reference between $ref_docswebtemplate and local repo in $DESTINATION"; exit 5; } +#processing cloning or update +if [ -z $GITREF ]; then + echo "Cloning docwebtemplates and doctools in $DESTINATION" + gitclone $docswebtemplates . + gitcheckout $ref_docswebtemplate + gitclone $doctools $DOCTOOLSDIR + pushd $DOCTOOLSDIR + gitcheckout $ref_doctools + npm install + popd + echo "docwebtemplates and doctools cloned in $DESTINATION" +else + echo "you are in docs-webtemplate: process $DOCTOOLSDIR" + echo "so no process will be done in docs-webtemplate" + if [ -d $DOCTOOLSDIR ]; then + echo "$DOCTOOLSDIR already exits: process update with reference=$ref_doctools" + pushd $DOCTOOLSDIR + gitcheckout $branch_doctools + git pull $doctools $branch_doctools &> /dev/null + npm install + popd + else + echo "cloning $DOCTOOLSDIR" + gitclone $doctools $DOCTOOLSDIR + pushd $DOCTOOLSDIR + gitcheckout $ref_doctools + npm install + popd + fi + echo "doctools updated" +fi +popd diff --git a/packer/provision/agl_dependencies.sh b/packer/provision/agl_dependencies.sh index 1f06224e..d37f2c7e 100644 --- a/packer/provision/agl_dependencies.sh +++ b/packer/provision/agl_dependencies.sh @@ -75,6 +75,7 @@ which -a npm dpkg -L nodejs npm install --global gulp bower +################### SDX181207 { - obsolete: section until closing brace should be removed after migration to next docsite # tools used to generate developer website (https://github.com/automotive-grade-linux/docs-agl) gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 \ && curl -sSL https://get.rvm.io | bash -s stable --ruby --gems=jekyll @@ -97,6 +98,7 @@ npm install #gem install --no-user-install -V --version 1.13.1 kramdown ### hope that is enough +################### SDX181207 } - (closing brace) # ruby markdown linter sudo gem install mdl |