Remove full tests from CIs

santisoler commented 4 years ago

Add minimal test function that checks if all files in registry are available for download. Run only style checks on Azure Pipelines. Run only a single Travis CI configuration with Python 3.6 that runs the minimal test, style checks and deploys documentation and releases to PyPI. Remove uploading coverage to Codecov. Remove doc/gallery form .gitignore. Add all files inside gallery/doc. Create new targets for doc/Makefile: html-noplot, gallery and clean-gallery. The first one builds the website without running examples, the second one runs the examples and builds the website, the third one cleans doc/gallery directory. Change default target all to html-noplot. Update Pull Request template from fatiando/.github and add new remainders for contributors to build the docs and push changes on doc/gallery, and for maintainers to run all tests before merging the PR.

Fixes #77

Reminders

[ ] Run make format and make check to make sure the code follows the style guide.
[ ] Add tests for new features or tests that would have caught the bug that you're fixing.
[ ] Add new public functions/methods/classes to doc/api/index.rst.
[ ] Write detailed docstrings for all functions/methods.
[ ] If adding new functionality, add an example to the docstring, gallery, and/or tutorials.

santisoler commented 4 years ago

@leouieda Should we also remove the .codecov.yml file?

leouieda commented 4 years ago

Yeah, if we're not running the tests on CI then it's kind of useless.

leouieda commented 4 years ago

We'll also need to remove the requirements for coverage from the PR status checks.

leouieda commented 4 years ago

@santisoler I'm going to push the updates to the travis config here to see if we can trigger the build.

santisoler commented 4 years ago

Thanks Leo!

santisoler commented 4 years ago

@leouieda I've modified some targets in doc/Makefile. By default it will not run the gallery examples. I have added two more targets:

gallery: for running the gallery and building the entire website.
clean-gallery: for removing the doc/gallery directory.

What do you think about this?

leouieda commented 4 years ago

So to build the docs for a new gallery plot we'd have to run make gallery only? Is that needed actually? Wouldn't sphinx-gallery know not to rebuild the examples since they are in the repository already?

santisoler commented 4 years ago

So to build the docs for a new gallery plot we'd have to run make gallery only? Is that needed actually? Wouldn't sphinx-gallery know not to rebuild the examples since they are in the repository already?

Yes, sphinx-gallery would know not to build the gallery examples if the built files are in doc/gallery. If we are opening a PR with a new example but we haven't built the gallery yet, then the CIs will try to build them, and we want to avoid that. That's why I though it would be better to explicitly instruct CIs not to build the examples.

leouieda commented 4 years ago

Ah right, as always you saw something I overlooked :slightly_smiling_face: Did I ever mention that I'm really glad you got on board?

OK, then I fully agree with the idea of separating the gallery plot.

fatiando / rockhound

Remove full tests from CIs #78