IntenseFinance/nosqlbench
3
0
Fork 0
mirror of https://github.com/nosqlbench/nosqlbench.git synced 2025-02-25 18:55:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

merge AUTOMATION.md into BUILDING.md

Browse Source
This commit is contained in:
Jonathan Shook
2020-03-18 12:40:35 -05:00
parent e026e993c6
commit d9fbd3bdde
2 changed files with 26 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
AUTOMATION.md
View File

@@ -1,19 +0,0 @@
## CI and Github Actions
This project uses github actions to manage continuous integration.
Below is a sketch of how the automation currently works.
### releases
The releases workflow is responsible for thie following:
1. Build nb and nb.jar binaries and application content.
2. Publish new nb.jar releases to maven via Sonatype OSSRH.
3. Upload release assets to the newly published release.
4. Upload updated docs to the github pages site for docs.nosqlbench.io
5. (future) upload updated javadocs ot the github pages site for javadoc.nosqlbench.io/...
### build
The build workflow simply builds the project and then verifies it in that order
using the standard maven mojo.

28
BUILDING.md
View File

@@ -4,7 +4,9 @@
You need Java 11 or newer to build NoSQLBench.
# mvn package
# Building Locally
## mvn package
To build NoSQLBench in its entirety, you simply need to run
@@ -19,7 +21,7 @@ within the Maven build mojo, including the following:
- Building the static guidebook in nb/target/guidebook
- Exporting all the bundled markdown into nb/target/guidebook
# mvn verify
## mvn verify
The integration tests for NoSQLBench are run in the verify phase.
You can run these tests with `mvn verify`. These tests are based
@@ -28,4 +30,26 @@ output. They can take quite a bit of time, but there is no substitute
for this level of testing, particularly for a tool that is used
to test other systems.
# Automation
## CI and Github Actions
This project uses github actions to manage continuous integration.
Below is a sketch of how the automation currently works.
### releases
The releases workflow is responsible for thie following:
1. Build nb and nb.jar binaries and application content.
2. Publish new nb.jar releases to maven via Sonatype OSSRH.
3. Upload release assets to the newly published release.
4. Upload updated docs to the github pages site for docs.nosqlbench.io
5. (future) upload updated javadocs ot the github pages site for javadoc.nosqlbench.io/...
### build
The build workflow simply builds the project and then verifies it in that order
using the standard maven mojo.