Skip to content

Latest commit

 

History

History
115 lines (66 loc) · 2.77 KB

readme-build.md

File metadata and controls

115 lines (66 loc) · 2.77 KB

Modules

By default Fabric8 builds the set of modules required by the karaf distribution and runs the associated integration tests. There are three main build targets associated with corresponding maven profiles

  • tomcat: Fabric8 on Tomcat
  • wildfly: Fabric8 on WildFly
  • all: All available modules

Build examples are below

Committers

Be sure to check out the committer instructions on how to fork this repo and submit Pull Requests

Building Fabric8

Build Fabric8 and run the associated smoke tests

> mvn clean install

Build Fabric8 Tomcat and run the associated tests

> mvn clean install -Ptomcat

Build Fabric8 WildFly and run the associated tests

> mvn clean install -Pwildfly

Build Fabric8 using latest hawtio Snapshot and run the associated tests

> mvn -Phawtio-snapshot clean install

Note, to avoid getting prompted for a gpg key add -Dgpg.skip=true

Quick Builds

You can do quick builds by appending -DskipTests

Build Fabric8 and skip tests

> mvn clean install -DskipTests

Build fabric8 with all modules and skip tests

Test Profiles

Fabric8 tests are seperated in serveral dedicated tests profiles

  • ts.smoke: Smoke tests
  • ts.basic: Basic integration tests
  • ts.all: All of the above

Examples

Build Fabric8 and run the smoke and basic integration tests

> mvn clean install -Dts.basic

Build Fabric8 and run all tests

> mvn clean install -Dts.all

Build fabric8 with all modules and run all tests

> mvn clean install -Pall -Dts.all

License check

The source code uses the license header from the file fabric-license-header.txt in the root directory.

You can check for missing licenses in the source code, by enabling the license profile and run the following goal from the root directory. Notice this will check all the source code:

> mvn license:check -Plicense -Dlicense.header=fabric-license-header.txt

And from any sub module, you need to refer to the license file using a relative path:

   > cd fabric
   > cd fabric-agent
   > mvn license:check -Plicense -Dlicense.header=../../fabric-license-header.txt

You can update the license headers in the source code using the format goal, for example:

> mvn license:format -Plicense -Dlicense.header=../../fabric-license-header.txt

GitBook

The documentation is compiled into a book using GitBook.

First install gitbook using npm

npm install gitbook -g

And then build the book locally using

cd docs
gitbook serve ./

And access the book from a web browser at

http://localhost:4000

To add new sections into the gitbook, ecit the docs/SUMMARY.md file.