Stream: GCI announce

Topic: trailing whitespace

Steve Howell (showell) (Dec 19 2016 at 17:25):

One common error that we have been noticing in student submissions is that folks have trailing whitespace in their code or documents. One thing you can do to prevent this is to run ./tools/lint-all before pushing. It usually takes about 10 to 20 seconds to run the linter, and it catches lots of different mistakes.

Yago González (Dec 19 2016 at 18:43):

@Steve Howell I was surprised to see that ./tools/lint-all doesn't report some errors that ./tools/lint-all --pep8 does report.

Since the test suite checks both, not running both may cause problems in Travis CI.

Steve Howell (showell) (Dec 19 2016 at 18:46):

Yeah, so some checks, like the --pep8 check, take a really long time, so we don't include them in ./tools/test-all, but you can still run them locally if you are patient.

Yago González (Dec 19 2016 at 18:47):

So... the proper procedure before pushing a PR would be running both, right?

Steve Howell (showell) (Dec 19 2016 at 18:47):

$ cat tools/travis/backend 
#!/bin/bash

source tools/travis/activate-venv

set -e
set -x

./tools/lint-all --pep8 # Include the slow and thus non-default pep8 linter check
./tools/test-backend --coverage --no-verbose-coverage
./tools/test-management
./tools/test-migrations
./tools/test-run-dev
./tools/test-documentation
# Some test suites disabled in CI for being flaky
#./tools/test-queue-worker-reload

Steve Howell (showell) (Dec 19 2016 at 18:47):

Yeah, generally.

Yago González (Dec 19 2016 at 18:48):

Right, thanks!

Steve Howell (showell) (Dec 19 2016 at 18:48):

I mean, it's not the end of the world to let Travis catch these errors--it's part of what Travis is for--but you can proactively run stuff locally to avoid the long Travis turnaround.

Yago González (Dec 19 2016 at 18:49):

Yeah, it's just to avoid having to wait for Travis. Since the builds queue is large, some tests may take hours to finish (like in my last PR, for instance)

Steve Howell (showell) (Dec 19 2016 at 18:49):

Often, if I'm 95% confident my code is clean, I'll just submit it to Travis without running every single check, but then if Travis complains, I'll run specific commands before pushing again.

Yago González (Dec 19 2016 at 18:49):

That's why I want to make sure as much as possible that all Travis tests will pass

Yago González (Dec 19 2016 at 18:50):

For the moment I don't think I can be 95% confident about anything I code, hahahahaha

Steve Howell (showell) (Dec 19 2016 at 18:52):

:)

Last updated: Jul 19 2022 at 08:22 UTC