Skip to content

Latest commit

 

History

History
71 lines (45 loc) · 1.08 KB

common-commands.md

File metadata and controls

71 lines (45 loc) · 1.08 KB

Common development-related commands

License Management

To check preamble is included in all source files:

mvn license:check

To add the preamble to all source files:

mvn license:format

Source Formatting

To check source formatting:

mvn formatter:validate

To reformat all Java sources:

mvn formatter:format

Source Validation

To check for other source issues (e.g., Javadoc):

mvn checkstyle:check

Release-Related Commands

Tagging a release

To perform a release on develop or a release branch:

mvn -Prelease -Preporting release:clean release:prepare

No need to include the release:perform goal, since this is handled by the GitHub actions CI/CD.

Building the website

To build the website:

mvn -Preporting site site:stage

Build Management

To look at the build plan:

mvn -Prelease -Preporting  fr.jcgay.maven.plugins:buildplan-maven-plugin:list-phase -Dbuildplan.tasks="deploy,site"

To look at the effective POM:

mvn -Prelease -Preporting help:effective-pom