1. Build Automation

Internship Diary uses Gradle for build automation.

See UsingGradle.adoc for more details.

2. Continuous Integration

Internship Diary uses Travis CI for continuous integration.

See UsingTravis.adoc for more details.

3. Coverage Reporting

Internship Diary uses Coveralls to track code coverage.

See UsingCoveralls.adoc for more details.

4. Automated Code Review

Internship Diary uses Codacy to automate code reviews.

5. Managing Dependencies

Sometimes third-party libraries may be required (e.g. Jackson library for JSON parsing). You may include such dependencies into the project using the 2 ways:

  1. Use Gradle to automatically manage the dependencies
    (Gradle can download the dependencies automatically)

  2. Manually download and include the libraries in the repository
    (Note that this will require extra work and may bloat the repo size)

6. Making a Release

Here are the steps to create a new release.

  1. Update the version number in MainApp.java.

  2. Generate a JAR file using Gradle.

  3. Tag the repo with the appropriate version number. e.g. v2.0

  4. Create a new release using GitHub and upload the JAR file you created.