Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 1.8 KB

BUILD.md

File metadata and controls

62 lines (42 loc) · 1.8 KB
Raw

Building Eclair

Requirements

Build

Eclair is packaged as a compressed archive with a launcher script, the archives are built deterministically so it's possible to reproduce the build and verify its equality byte-by-byte. To build the exact same artifacts that we release, you must use the build environment (OS, JDK, maven...) that we specify in our release notes.

To build the project and run the tests, simply run:

mvn package

NB: if the build fails, you may need to clean previously built artifacts with the mvn clean command. NB: some of the tests use Docker, so make sure your docker daemon is running.

Other build options

To skip all tests, run:

mvn package -DskipTests

To only build the eclair-node module, run:

mvn package -pl eclair-node -am -DskipTests

To run the tests, run:

mvn test

To run tests for a specific class, run:

mvn test -Dsuites=*<TestClassName>

Build the API documentation

Slate

The API doc is generated via slate and hosted on github pages. To make a change and update the doc follow the steps:

  1. git checkout slate-doc
  2. Install your local dependencies for slate, more info here
  3. Edit source/index.html.md and save your changes.
  4. Commit all the changes to git, before deploying the repo should be clean.
  5. Push your commit to remote.
  6. Run ./deploy.sh
  7. Wait a few minutes and the doc should be updated at https://acinq.github.io/eclair