Skip to content

This maven plugin checks and unifies a project's structure according to the Exasol integration team's repository standards.

License

Notifications You must be signed in to change notification settings

exasol/project-keeper

Repository files navigation

Project Keeper Maven Plugin

Build Status Project Keeper Core: Maven Central – Project Keeper Core, Project Keeper Command Line Interface: Maven Central – Project Keeper Command Line Interface, Project Keeper Maven plugin: Maven Central – Project Keeper Maven plugin

Quality Gate Status

Security Rating Reliability Rating Maintainability Rating Technical Debt

Code Smells Coverage Duplicated Lines (%) Lines of Code

This maven plugin checks and unifies the project's structure according to the Exasol integration team's repository standards.

Usage in a Nutshell for Maven

  1. Create config file ~/.m2/toolchains.xml for the Maven toolchains plugin, see user guide for details.

  2. Create config file .project-keeper.yml:

    sources:
      - type: maven
        path: pom.xml
        modules:
          - maven_central
  3. Add PK plugin to your pom.xml:

    <plugins>
        <plugin>
            <groupId>com.exasol</groupId>
            <artifactId>project-keeper-maven-plugin</artifactId>
            <version>CURRENT VERSION</version>
            <executions>
                <execution>
                    <goals>
                        <goal>verify</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
  4. Run PK fix:

    mvn project-keeper:fix --projects .
  5. Run PK verify:

    mvn project-keeper:verify --projects .

See the User Guide for details and for non-Maven projects.

Additional Resources