DevOps Guide

Table of contents

1. Build automation
2. Making a release

1. Build automation

This project uses Gradle for build automation and dependency management.

Given below are how to use Gradle for some important project tasks.

• clean: Deletes the files created during the previous build tasks (e.g. files in the build folder).
  e.g. ./gradlew clean

• shadowJar: Uses the ShadowJar plugin to creat a fat JAR file in the build/lib folder, if the current file is outdated.
  e.g. ./gradlew shadowJar.

• run: Builds and runs the application.
  runShadow: Builds the application as a fat JAR, and then runs it.

• checkstyleMain: Runs the code style check for the main code base.
  checkstyleTest: Runs the code style check for the test code base.

• test: Runs all tests.

  • ./gradlew test — Runs all tests
  • ./gradlew clean test — Cleans the project and runs tests

2. Making a release

Here are the steps to create a new release.

1. Update the version number in MainApp.java.
2. Generate a fat JAR file using Gradle (i.e., gradlew shadow).
3. Tag the repo with the version number. e.g. v0.1
4. Create a new release using GitHub. Upload the JAR file you created.
5. We have created 3 releases.V1.0, V2.0 and V2.1

Home Page