Container
There is no need to download or build garbagecat to run the latest code. Simply run the container release, which is updated with each commit.
For example, run the following in the directory where gc-example exists (GARBAGECAT_HOME/src/test/):
$ docker run --pull=always -v "$PWD":/home/garbagecat/files:z ghcr.io/mgm3746/garbagecat:latest --console -p -t 20 /home/garbagecat/files/gc-example.log > report.txt
NOTES:
- Local directory gets mounted to the /home/garbagecat/files/ container directory.
- The local directory must have world execute permission (Linux).
- The report is written to stdout with the --console option.
- Containers are automatically updated with each commit, so you are always running with the lastest updates.
- Supported architectures are x86_64 and arm64.
Build
Get source:
$ git clone https://github.com/mgm3746/garbagecat.git
Build it:
$ cd garbagecat
$ /path/to/mvn clean (rebuilding)
$ /path/to/mvn --settings settings.xml package
$ export JAVA_HOME=/usr/lib/jvm/java/ (or wherever a JDK is installed)
$ /path/to/mvn --settings settings.xml javadoc:javadoc