CONTRIBUTING.adoc

Contributors Guide

Table of Contents

• Local Environment
• Running Tests
  • Execute tests for a specific library
  • Execute tests for a specific Specification file
  • Code Coverage
• Building the Documentation
  • Customizing the documentation output directory
• Releasing the SDP Libraries

Local Environment

Table 1. Tools

Tool	Purpose
Gradle	Used to run unit tests
Just	A task runner. Used here to automate common commands used during development.
Docker	Used to build the documentation for local preview

Running Tests

To run all the tests, run:

just test

The gradle test report is published to target/reports/tests/test/index.html

Execute tests for a specific library

To run tests for a specific library, docker for example, run:

just test '*docker*'

Execute tests for a specific Specification file

To run tests for a specific Specification file, test/docker/BuildSpec.groovy for example, run:

just test "*.BuildSpec"

Code Coverage

By default, JaCoCo code coverage is enabled when running test.

Once executed, the JaCoCo coverage report can be found at: target/reports/jacoco/test/html/index.html

To disable this, run:

just --set coverage false test

Building the Documentation

This project uses Antora to build the documentation.

To build the documentation, run:

just docs

Once built, the documentation can be viewed at docs/html/index.html

Customizing the documentation output directory

The docsDir justfile variable configures the output directory.

To modify the output directory, run:

just --set docsDir some/other/directory docs

Releasing the SDP Libraries

If you have the permission, you can cut a new release of the SDP libraries by running just release <versionNumber>.

For example:

just release 3.0

This will:

1. create a release/3.0 branch

2. update the version in the docs/antora.yml

3. create a 3.0 tag

Note	Don’t forget to go to the Releases Page to officially release the SDP Libraries with the current change log based off the most recent tag.