gatoreducator/dockagator repository overview

⁠DockaGator

This repository contains the infrastructure needed to generate a Docker image that can run GatorGradle⁠ on an assignment or project.

⁠Build

Simply run ./build.sh to generate a new image locally.

⁠Run

Execute the following docker run command to start gradle grade as a containerized application.

docker run --rm --name dockagator \
  -v "$(pwd)":/project \
  -v "dockagator":/root/.local/share \
  gatoreducator/dockagator

This will use "$(pwd)" (the current directory) as the project directory and create a separate Docker Volume for the GatorGrader installation; the project directory must exist and contain something. To view the cache volume you can use an interactive container; this can be used both to run back-to-back gradle grade commands, or inspect /root/.local/share, which is where the volume is mounted.

docker run -it --rm --name dockagator \
  -v "$(pwd)":/project \
  -v "dockagator":/root/.local/share \
  gatoreducator/dockagator /bin/bash

⁠Contributing

To update DockaGator with new executables, features, or other changes, first create a branch and make your changes there. Then, make a PR for that branch and add the correct label for the type of change you're making (major, minor, or patch). Finally, make sure to include release notes headed by # Release notes so that the automated release creation process can use them. Now, if all CI checks pass, your PR is ready for review. Once it is merged a release will be created, providing a new docker image on both Docker Hub⁠ and the Github docker repository.