Skip to content

Squeaky CI failures need more clear instructions #838

@Eric-Arellano

Description

@Eric-Arellano

There are two issues:

  1. 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.
  2. 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.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions