Table of Contents

  1. Build automation
  2. Continuous integration (CI)
    1. Code coverage
    2. Repository-wide checks
  3. Making a release

Build automation

This project uses Gradle for build automation and dependency management. You are recommended to read this Gradle Tutorial from the se-edu/guides.

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

Continuous integration (CI)

This project uses GitHub Actions for CI. The project comes with the necessary GitHub Actions configurations files (in the .github/workflows folder). No further setting up required.

Code coverage

As part of CI, this project uses Codecov to generate coverage reports. When CI runs, it will generate code coverage data (based on the tests run by CI) and upload that data to the CodeCov website, which in turn can provide you more info about the coverage of your testes. Here are the steps to set up CodeCov for a fork of this repository.

  1. Sign up with Codecov using your GitHub account here.
  2. Once you are inside Codecov web app, add your org (that contains the fork) to CodeCov.
  3. Wait for the next run of CI in your fork (or push a dummy commit to it to trigger CI) to confirm CI is able to upload generated coverage data to CodeCov. If CodeCov is not set up correctly, the CI run will fail with an error message that mentions CodeCov.
  4. Get the Markdown code for the Codecov badge provided in Settings > Badges and update the docs/index.md of your repo with it so that the badge codecov in that page reflects the coverage of your project.

Repository-wide checks

In addition to running Gradle checks, CI includes some repository-wide checks. Unlike the Gradle checks which only cover files used in the build process, these repository-wide checks cover all files in the repository. They check for repository rules which are hard to enforce on development machines such as line ending requirements.

These checks are implemented as POSIX shell scripts, and thus can only be run on POSIX-compliant operating systems such as macOS and Linux. To run all checks locally on these operating systems, execute the following in the repository root directory:

./config/travis/run-checks.sh

Any warnings or errors will be printed out to the console.

If adding new checks:

  • Checks are implemented as executable check-* scripts within the .github directory. The run-checks.sh script will automatically pick up and run files named as such. That is, you can add more such files if you need and the CI will do the rest.
  • Check scripts should print out errors in the format SEVERITY:FILENAME:LINE: MESSAGE
    • SEVERITY is either ERROR or WARN.
    • FILENAME is the path to the file relative to the current directory.
    • LINE is the line of the file where the error occurred and MESSAGE is the message explaining the error.
  • Check scripts must exit with a non-zero exit code if any errors occur.

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 shadowJar).
  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.