Build workflow

[kmuehlbauer]

The erad2022 build workflow has been adapted as follows:

(see pull requests #30, #31, #32, #33)

On PullRequest:

1. repo2docker-action is used to build the docker image
   • docker layers will be cached from ghcr.io (https://github.com/openradar/erad2022/pkgs/container/erad2022)
   • image is not pushed, since GITHUB_TOKEN write is not available as per security policy
2. book is built in a second step using docker-run-action, zipped and uploaded as artifact
3. book is deployed to gh-pages, link is added to pr comment

On Push:

1. repo2docker-action is used to build the docker image
   • docker layers will be cached from ghcr.io (https://github.com/openradar/erad2022/pkgs/container/erad2022)
   • image is pushed to ghcr.io (https://github.com/openradar/erad2022/pkgs/container/erad2022)
2. book is built in a second job directly inside ghcr.io (https://github.com/openradar/erad2022/pkgs/container/erad2022), zipped and uploaded as artifact
3. book is deployed to gh-pages https://openradarscience.org/erad2022/

Depending on the changes in the repo the build times can be quite low as docker layer caching is facilitated.

Debugging locally:

If you want to debug locally using repo2docker you would need to remove (temporarily) the binder/Dockerfile. Then you would need to invoke the build with:

$ repo2docker --appendix "`cat binder/appendix.txt`" .

This will build the image and fire up a container running jupyterlab.

Conclusion:

• Docker images are built using GHA with all essential components inside (and pushed to ghcr.io on push)
• On binder we are using now our prebuild images on ghcr.io https://github.com/openradar/erad2022/pkgs/container/erad2022. As we are using appendix instead of postBuild no compilations are necessary on the binder side, the images is used as is with some minor adaptions by binder.
• On GHA we are using our prebuild images as layer cache, but layers can't be updated on pull requests due to security reasons.
• The erad2022 package on https://ghcr.io/openradar/erad2022:latest represents always the status of the most recent commit to the repo.

Note: Build times depend on the changes in the repo. A change to environment.yml for instance would trigger a complete rebuild of the conda environment. From experience the image build should not take more than 12 minutes.In some cases the time has been down to around 5 minutes.

Happy coding!