Reaction: Deploy-docs step fails consistently during CI

[spencern]

Summary

Our CI is reporting failure due to the deploy-docs step that happens when our master branch is updated. If we still rely on this step to deploy docs, let's fix this. If we don't, let's eliminate it please. I'd like Circle to report success for our master branch. Our CI process should give us and people looking at our projects confidence that the tests are passing and the project is maintained.

Generating output files...
Finished running in 9.28 seconds.
Exited with code 1

[spencern]

@machikoyasuda do you know if we're still relying on this step for our documentation to stay up-to-date?

[machikoyasuda]

There must be a JSDoc that is not compiling correctly: https://app.circleci.com/jobs/github/reactioncommerce/reaction/47338

The deploy-docs step builds this site: http://api.docs.reactioncommerce.com/ and if there's any JSDoc comment that causes the compile step to break, the job will fail.

[spencern]

Thanks. Lemme rerun via SSH and see if it will tell me what's broken

[spencern]

Interestingly - when running via SSH I was able to deploy the docs with no errors. 🤔

[spencern]

Building the docs connected via SSH returns 0

circleci@4027eeda8d7e:~/reaction-app$ echo "$?"
0

[spencern]

Annnd. I think I found it.
https://github.com/reactioncommerce/reaction/blob/master/imports/plugins/included/product-admin/client/hocs/withVariant.js#L109

Fix incoming if it's what I suspect

[machikoyasuda]

@spencern Good catch!!

[aldeed]

I'd like to keep this and also have merges to develop deploy to a different bucket+url. Both should be linked to from the main docs site. Eventually we can roll this into the overall pattern for keeping versioned docs in each repo /docs.