Skip to content
Snippets Groups Projects
  • Josh Rosen's avatar
    972673ac
    [SPARK-16555] Work around Jekyll error-handling bug which led to silent failures · 972673ac
    Josh Rosen authored
    If a custom Jekyll template tag throws Ruby's equivalent of a "file not found" exception, then Jekyll will stop the doc building process but will exit with a successful status, causing our doc publishing jobs to silently fail.
    
    This is caused by https://github.com/jekyll/jekyll/issues/5104, a case of bad error-handling logic in Jekyll. This patch works around this by updating our `include_example.rb` plugin to catch the exception and exit rather than allowing it to bubble up and be ignored by Jekyll.
    
    I tested this manually with
    
    ```
    rm ./examples/src/main/scala/org/apache/spark/examples/sql/SparkSQLExample.scala
    cd docs
    SKIP_API=1 jekyll build
    echo $?
    ```
    
    Author: Josh Rosen <joshrosen@databricks.com>
    
    Closes #14209 from JoshRosen/fix-doc-building.
    972673ac
    History
    [SPARK-16555] Work around Jekyll error-handling bug which led to silent failures
    Josh Rosen authored
    If a custom Jekyll template tag throws Ruby's equivalent of a "file not found" exception, then Jekyll will stop the doc building process but will exit with a successful status, causing our doc publishing jobs to silently fail.
    
    This is caused by https://github.com/jekyll/jekyll/issues/5104, a case of bad error-handling logic in Jekyll. This patch works around this by updating our `include_example.rb` plugin to catch the exception and exit rather than allowing it to bubble up and be ignored by Jekyll.
    
    I tested this manually with
    
    ```
    rm ./examples/src/main/scala/org/apache/spark/examples/sql/SparkSQLExample.scala
    cd docs
    SKIP_API=1 jekyll build
    echo $?
    ```
    
    Author: Josh Rosen <joshrosen@databricks.com>
    
    Closes #14209 from JoshRosen/fix-doc-building.