-
Notifications
You must be signed in to change notification settings - Fork 173
Infrastructure docs draft
This page should eventually go into the docs. I'm using the Wiki to jot down pointers/draft.
Here are the infrastructure pieces that currently (as of 14 June 2020) exist for pyjanitor, and what they are used for/why they exist.
Travis is used for CI pipelines.
Backup deployment of docs to ericmjl.github.io/pyjanitor happens via Travis, in case ReadTheDocs goes down. Here, notebooks are executed.
Azure provides macOS and Windows builds for the CI pipelines. There's overlap with Travis, in that the Linux builds happen there too.
The Windows builds are borked, btw; things can fail on macOS and Linux but they still pass on Windows. It's weird.
ReadTheDocs is the primary documentation host provider. It automatically builds the docs.
Notebook execution - I'm not sure whether this happens. Need to check.
Checks for code bugs and coding anti-patterns automatically. I found this via @shaypal5/cachier.
Gives us a platform for reviewing PRs that involve notebooks.
This bot slows me down before smashing the big green button when PRs are labelled "WIP", by not letting the merge button turn green.
We use coverage.py to check code coverage. CodeCov gives us snapshots of previous code coverage reports, to see whether code test coverage has gone down or not. We don't want it to go down, we want it to go up, or at least stay level.