Warning

Most of the stuff here is outdated and not how we'd do things any more regarding dockerfiles, docker-compose, etc, and probably other stuff. At this point if we wanted to start a brand-new repository we would probably want to strongly consider trying Python.

Template repository for Ruby project using shared HathiTrust GitHub Actions workflows

The example uses a Dockerfile for a Ruby project, but the GitHub Actions workflows are applicable to projects in perl as well.

To be able to deploy to Kubernetes using these actions, you will need to first set up secrets using use https://github.com/mlibrary/config-repo-env.

See also the actions these workflows use:

• https://github.com/hathitrust/github_actions
• https://github.com/mlibrary/deploy-to-kubernetes

This repository includes:

• examples for badges for tests, coveralls, and standardrb
• Github Actions workflows for building a Docker image and deploying to Kubernetes. See individual workflows for additional comments.
• starter Dockerfile, Dockerfile.prod, and docker-compose.yml, which implement our best attempt at a strategy around gem caching.
• LICENSE required by all HathiTrust projects
• Starter Gemfile, rspec, coveralls configuration
• wait-for from https://github.com/eficode/wait-for, which we use extensively in CI workflows for waiting for mysql etc to become ready

Usage

Use this template, or copy individual files into your project.

When using this template, document inline variation in the Dockerfiles and github actions. That will help in understanding divergence between individual projects and future updates to this template.