Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace conda for pip on Actions and split requirements files #282

Merged
merged 11 commits into from
Nov 19, 2021

Conversation

santisoler
Copy link
Member

@santisoler santisoler commented Nov 16, 2021

Create a new env directory with some requirements-*.txt files, each one
with the specific dependencies to run certain tasks, like checking style,
running the test, publishing to PyPI and building the docs. The GitHub Actions
now use pip to install the dependencies instead of having to setup Miniconda
and install them through conda. The only exception is the one that builds the
docs: we need pyproj and cartopy to do so and they are easier to install
through conda.

Fixes #257

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 and the base __init__.py file for the package.
  • Write detailed docstrings for all functions/classes/methods. It often helps to design better code if you write the docstrings first.
  • If adding new functionality, add an example to the docstring, gallery, and/or tutorials.
  • Add your full name, affiliation, and ORCID (optional) to the AUTHORS.md file (if you haven't already) in case you'd like to be listed as an author on the Zenodo archive of the next release.

The requirements.txt has only the dependencies for running harmonica.
The envs directory hosts files with requirements for particular tasks:
building the wheel, running tests, checking style and building docs.
Verde is already a dependency present in requirements.txt
For building the docs we need pyproj and cartopy that are easier to
install via conda.
@santisoler santisoler added the maintenance A maintenance task to improve development label Nov 16, 2021
@santisoler santisoler changed the title WIP Replace conda for pip on Actions and split requirements files Replace conda for pip on Actions and split requirements files Nov 17, 2021
Copy link
Member

@leouieda leouieda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! Left a comment on the pip cache part but I'm not sure if it's relevant.

.github/workflows/test.yml Outdated Show resolved Hide resolved
@santisoler santisoler merged commit aa7ed61 into master Nov 19, 2021
@santisoler santisoler deleted the actions-pip branch November 19, 2021 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance A maintenance task to improve development
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactor CIs by splitting package requirements as needed
2 participants