CI: fix the YAML syntax for the docs job, and thus properly surface any docbuild failures

[DilumAluthge]

Fixes the "silent" part of #1045

Obviously doesn't actually fix the underlying doc failure.

[codecov-commenter]

Codecov Report

Merging #1046 (07acd86) into dev (7c677a2) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev    #1046   +/-   ##
=======================================
  Coverage   60.97%   60.97%           
=======================================
  Files           2        2           
  Lines          41       41           
=======================================
  Hits           25       25           
  Misses         16       16           

[DilumAluthge]

@ablaom This is now ready for review.

[ablaom]

@OkonSamuel Can you please review this and follow up? I think we need a PR to master to test the current fail is detected.

[DilumAluthge]

I can push a commit to this branch to demonstrate that it detects the failure.

[DilumAluthge]

@ablaom As you can see on the test commit d66d829, we correctly detect the docs failure.

[ablaom]

Thanks @DilumAluthge . I'm convinced. If you could kindly restore to previous state we can merge.

[OkonSamuel]

@DilumAluthge But I don't see how the code differs from what was initially there. Any idea what was the reason for the silent failures?

[DilumAluthge]

Yeah. The YAML wasn't getting parsed correctly. So while we had intended to write this:

@info "attempting to build the docs"
run(`julia --project=docs docs/make.jl`)

Where that would have been two separate lines, we instead wrote this:

@info "attempting to build the docs" run(`julia --project=docs docs/make.jl`)

Where it all became one line. So it was equivalent to writing the following in Julia:

@info "my message" f()

In Julia, if you write @info "my message" f(), and if f() throws an exception, the overall @info will NOT throw an exception; it will print a warning message, but it will not error.

[ablaom]

Thanks for that @DilumAluthge . Can we please have a "restore" commit so that docs don't get generated on PR's to dev?

[ablaom]

Good to go!

Thanks @DilumAluthge for jumping in here.

[DilumAluthge]

@ablaom Can you make a PR to merge dev into master?

[ablaom]

I was going to wait for a fix to the cause of the fail (tracking this at #1045). I haven't got around to that.