Skip to content

Latest commit

 

History

History
41 lines (33 loc) · 1.64 KB

BUILDING.md

File metadata and controls

41 lines (33 loc) · 1.64 KB
Raw

Building Eclipse JKube (Internal documentation)

Javadoc

Applicable profiles: javadoc, release

Javadoc can be generated for the global project running the following command from the root directory:

mvn clean install -Pjavadoc

This will generate Javadoc for each module in target/apidocs and a jar package target/${project.artifactId}-${project.version}.jar.

The affected profiles will "delombok" the source code before generating the documentation in order to spread the "condensed" javadoc declared in the Lombok affected fields.

Release process

Release process has to be performed in a project fork.

A pull request with 2 commits must be generated, one with the release version and another with the next snapshot version.

Steps

  1. Update/rebase master branch to upstream
  2. Set release version 0. Set release version for all modules 
    mvn versions:set -DnewVersion=x.y.z -DgenerateBackupPoms=false
    1. Set release version for quickstarts
    ./scripts/quickstarts.sh version
  3. Update documentation 0. Add new entry to compatibility matrices 0. ./kubernetes-maven-plugin/doc/src/main/asciidoc/inc/_compatibility.adoc 0. ./kubernetes-maven-plugin/README.md 0. ./openshift-maven-plugin/doc/src/main/asciidoc/inc/_compatibility.adoc 0. Set date and version in CHANGELOG.md SNAPSHOT entry