How to properly create a maven module

Owned by Mustapha Zorgati
Last updated: Apr 28, 2022
1 min read

This short checklist assists you in creating a maven module and adding it everywhere

  • Create the maven module

    • add the <name>${project.groupId}:${project.artifactId}</name> and <description>THE MODULE DESCRIPTION</description>

  • Make sure that the module is part of the underlying reactor pom

    • add a reference to the logically correct parent pom

    • reference the new module from that parent pom

  • Add the module as a dependency to ci/taskana-sonar-test-coverage or ci/taskana-adapter-sonar-test-coverage (depending on the repository) so that the test coverage is computed correctly

  • For the Taskana/taskana repository: make sure that the module is listed (with the proper test database) in the test_backend job’s matrix. File: .github/workflows/continuous-integration.yml

  • If the module should be released: make sure that the module is listed in the Release artifacts to OSS Sonatype step

  • Add the following dependency to your module if not available in the parent pom

<dependency> <groupId>pro.taskana</groupId> <artifactId>taskana-common-logging</artifactId> <version>${project.version}</version> </dependency>

  • Ask an administrator to add the new module to the GitHub status check restriction (after PR creation)