There are two issues:
- The failure prevents us from uploading notebooks. We early exit when the lint job fails, so don't execute then upload the formatted notebooks. That means you must run
tox -e fix locally.
- The error message is misleading in CI. It says:
Problems in 1 notebook; to fix, run
squeaky path/to/notebook.ipynb
It'd be nice if the error message instead explained what our README says, to either use tox -e fix or to download the notebook from CI. To pull this off, you could write a helper script to run squeaky and provide its own error message.
We also need to explain how to install Tox.
--
This issue is important because many of our technical writers are not very familiar with Tox and will benefit from more explicit instructions.
There are two issues:
tox -e fixlocally.It'd be nice if the error message instead explained what our README says, to either use
tox -e fixor to download the notebook from CI. To pull this off, you could write a helper script to run squeaky and provide its own error message.We also need to explain how to install Tox.
--
This issue is important because many of our technical writers are not very familiar with Tox and will benefit from more explicit instructions.