Commit 68365c94 authored by Evan W. Patton's avatar Evan W. Patton Committed by Jeffrey Schiller

Add ant flag force.builddocs

This change adds a property force.builddocs to the build script that
controls whether a failure to successfully execute Jekyll constitutes
a build failure or not. It defaults to false. In Jenkins we will set
it to true so that builds fail if they cause jekyll to fail. This way
people who do not have Jekyll installed can continue to work with the
sources. Since everything needs to pass Jenkins before being merged,
maintainers can run Jekyll to update the docs prior to merging.

Change-Id: I9fb22eea7582fb5ba5a83069778c23a40c14aaa8
parent cb06e6bd
...@@ -90,17 +90,19 @@ ...@@ -90,17 +90,19 @@
===================================================================== --> ===================================================================== -->
<target name="BuildDocs" depends="components_Markdown,CheckDocs" <target name="BuildDocs" depends="components_Markdown,CheckDocs"
unless="Docs.uptodate"> unless="Docs.uptodate">
<!-- Jenkins will pass -Dforce.builddocs=true to ensure docs build correctly -->
<property name="force.builddocs" value="false" />
<!-- We set failifexecutionfails to false so the whole build doesn't fail <!-- We set failifexecutionfails to false so the whole build doesn't fail
if the developer doesn't have Jekyll set up --> if the developer doesn't have Jekyll set up -->
<exec executable="bundle" failonerror="true" <exec executable="bundle" failonerror="${force.builddocs}"
failifexecutionfails="false" failifexecutionfails="${force.builddocs}"
dir="${docs.dir}/markdown" > dir="${docs.dir}/markdown" >
<arg value="install" /> <arg value="install" />
<arg value="--path" /> <arg value="--path" />
<arg value="vendor/bundle" /> <arg value="vendor/bundle" />
</exec> </exec>
<exec executable="bundle" failonerror="true" <exec executable="bundle" failonerror="${force.builddocs}"
failifexecutionfails="false" failifexecutionfails="${force.builddocs}"
dir="${docs.dir}/markdown" > dir="${docs.dir}/markdown" >
<arg value="exec" /> <arg value="exec" />
<arg value="jekyll" /> <arg value="jekyll" />
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment