ElArkk / jax-unirep

Reimplementation of the UniRep protein featurization model.
GNU General Public License v3.0
104 stars 31 forks source link

[WIP] GitHub actions ci #97

Closed ericmjl closed 3 years ago

ericmjl commented 3 years ago

PR Description

This PR introduces GitHub Actions as the CI pipeline for jax-unirep, replacing Travis CI.

Closes #91.

Left todo:

Checklist

General

  1. [x] I have made the PR off a new branch from my fork (<your_username>:<feature-branch_name>), not <your_username>:master.
  2. [ ] I have added my changes to the CHANGELOG.md file at the top.
  3. [ ] I have made any necessary changes to the documentation in the README.

Code checks

  1. [ ] If there are new features implemented, add suitable tests in the tests directory.
  2. [ ] If any new dependencies are introduced through the new features, add the packages, pinned to a version, to environment.yml.
  3. [ ] Run make test in a console in the top level directory to make sure all the tests pass.
  4. [ ] Run make format in a console in the top level directory to make the code comply with the formatting standards.
codecov[bot] commented 3 years ago

Codecov Report

Merging #97 (1ea5cc4) into master (42f1217) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #97   +/-   ##
=======================================
  Coverage   97.90%   97.90%           
=======================================
  Files          12       12           
  Lines         524      524           
=======================================
  Hits          513      513           
  Misses         11       11           
Flag Coverage Δ
python 97.90% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 42f1217...1ea5cc4. Read the comment docs.

ElArkk commented 3 years ago

Yo! What parts are still missing here? Docs, anything else? I could give implementing the docs a try to gain some familiarity with github actions as well, unless you have it already in the works?

ericmjl commented 3 years ago

I haven't attempted docs just yet -- please give it a shot! I'd say that the docs should run parallel to the tests, so if you sort of follow the pattern for the fast/slow tests section in the same YAML file, you'll be set.

ElArkk commented 3 years ago

@ericmjl I'm not sure whether the mkdocs deploy action can handle all the extra dependencies we need to build our docs. If we need to install our env first, do you know if we can use the build-environment step from continous-integration.yml directly in deploy-docs.yml, or do we need to copy it over?

ElArkk commented 3 years ago

Codecov-action behaves weird with coverage. Gonna change back to the old way since that worked fine.

ericmjl commented 3 years ago

@ericmjl I'm not sure whether the mkdocs deploy action can handle all the extra dependencies we need to build our docs. If we need to install our env first, do you know if we can use the build-environment step from continous-integration.yml directly in deploy-docs.yml, or do we need to copy it over?

I think those build steps will have to be copied over. There's a choice to be made on how to organize the YAML files, but I think organizing by "task to be done", rather than "on what trigger", makes the most sense.

ElArkk commented 3 years ago

Agree. I'll go ahead and copy them in.

ElArkk commented 3 years ago

Merging!