cnerg / learn-maintenance Goto Github PK

Most repo have a .gitignore file that tells git to not even try to include certain files. You can find some standard ones for python, but in this case, we want to ignore things like build, __pycache__, */*.egg-info

Currently, coverage/coveralls is running once for each version of python in the matrix. This seems like overkill. More over, for some reason, only the first one worked on merge of the branch.

https://github.com/CNERG/learn-maintenance/actions/runs/2907420994

The coveralls badge on the README added in #7 refers to @bquan0's repo and the badges branch

It should refer to the main branch on the CNERG fork

It is possible to add "badges" to the Readme file that are able to query the results of testing and coverage and report to readers.

Try adding these badges.

You have successfully made a dockerfile that generates a docker image that can be used locally for testing.

This step is to make a dockerfile that generates a docker image that installs all the dependencies and stops short of actually running the tests. Then you push this docker image to the Github Container Registry and then use that docker image, instead of ubuntu-latest to run your tests, and no longer need to install numpy, pytest, coverage.

1. write a new Dockerfile
2. write a new action that will build and push this docker image when the Dockerfile changes
3. change existing action to use the new docker image

The REGISTRY and IMAGE_NAME are defined in the environment, but used inconsistently or not used where appropriate. Specifically, the tag of the docker image that is build/pushed should derive from these.

Currently the push of the image fails in this merged upstream version because the image is tagged with github.actor instead of github.repository (I think). We won't be able to test that without another merge.

We know how to use the github actions cache to make an existing docker image available to streamline the building of a docker image with similar instructions.

We know how to pull an image from the image repository on a local machine to streamline the building of a docker image with similar instructions.

Can we pull an image from the image repository into a github actions cache to streamline things?

How to test:

1. a small dockerfile with at least 3 stages
2. a github action that build and pushes the docker images using three different jobs, one for each stage, and relying on the cache

Goal: github action doesn't repeat docker work for steps that have not changed.