Page MenuHomeElementl

[docs-infra] build test
Changes PlannedPublic

Authored by yuhan on Mar 12 2021, 8:56 PM.

Details

Reviewers
sashank
Summary

plan to land this ugly workaround for now to unblock the release
follow up issue: https://github.com/dagster-io/dagster/issues/3848

Test Plan

bk

Diff Detail

Repository
R1 dagster
Branch
yuhan/docs-build-test
Lint
Lint Warnings
SeverityLocationCodeMessage
Warningdocs/pack_json.py:117W0002Print Call
Warningdocs/pack_json.py:118W0002Print Call
Warningdocs/pack_json.py:120W0002Print Call
Unit
No Test Coverage

Event Timeline

Harbormaster returned this revision to the author for changes because remote builds failed.Mar 12 2021, 9:34 PM
Harbormaster failed remote builds in B27293: Diff 33380!
Harbormaster returned this revision to the author for changes because remote builds failed.Mar 12 2021, 10:56 PM
Harbormaster failed remote builds in B27300: Diff 33387!
Harbormaster returned this revision to the author for changes because remote builds failed.Mar 12 2021, 11:16 PM
Harbormaster failed remote builds in B27302: Diff 33389!
yuhan requested review of this revision.Mar 13 2021, 2:27 AM
yuhan added a reviewer: sashank.

Woo! Thanks for fixing this

docs/pack_json.py
109

Does this have some sort of side effect, like printing the diff? If not, should we delete this line?

This revision is now accepted and ready to land.Mar 14 2021, 4:54 AM
docs/pack_json.py
109

this prints out the names of entries where the diffs happen, like:

diffs:root['api']['apidocs']['cli']['body'].

root['api']['apidocs']['libraries']['dagster_celery']['body']

it's not perfect rn, bc, when this test fails, the git diff will be super long so you wont be able to debug via the bk ui - you will have to download the raw log and find these lines and debug from there, so it's still helpful.

i plan to dig into it later after the release - to make the stdout more helpful and make the parser smarter

not confident about this diff: enabling this test may cause unnecessary trouble for people when the local env isn't set up properly for the docs build.

planned changes as im revisiting this and think maybe we should include a convenient cmd which starts a fresh virtualenv, properly installs deps, and build docs