Skip to content

Commit

Permalink
NCL-6467: Document building and including/excluding tests
Browse files Browse the repository at this point in the history
  • Loading branch information
dwalluck committed Apr 29, 2021
1 parent 9d04b4e commit 73c54e5
Showing 1 changed file with 45 additions and 1 deletion.
46 changes: 45 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Table of Contents

Contributions to the project are very welcome! Please submit pull requests with any changes (preferably with tests).
Expand All @@ -12,6 +11,9 @@ Contributions to the project are very welcome! Please submit pull requests with
* [Logging](#logging)
* [Exceptions](#exceptions)
* [Gradle Test Runner](#gradle-test-runner)
* [Building](#building)
* [Running Tests](#running-tests)
* [Skipping Tests](#skipping-tests)
* [Releasing](#releasing)
* [Prerequisites](#prerequisites)
* [Release command](#release-command)
Expand Down Expand Up @@ -101,6 +103,48 @@ using single-test debugging):
Note that instead of calling `GradleRunner.create` the `TestUtils` class is used instead which passes on the extra system
properties.

### Building

To build GME and run all tests, use

```
gradle clean build
```

If you also wish to publish the artifacts to you local maven repository, replace `build` with `publishToMavenLocal`

```
gradle clean publishToMavenLocal
```

#### Running Tests

Normally, Gradle will only run tests if the code has changed. However, you may wish to force all tests to run using

```
gradle cleanTest test
```

Similarly, you can force all functional tests to run using

```
gradle cleanFunctionalTest functionalTest
```

#### Skipping Tests

If you wish to build excluding all tests and functional tests, use

```
gradle clean publishToMavenLocal -x test -x functionalTest
```

You may run only certain tests, e.g., the tests in a class named `TestClass`, using

```
gradle test --tests TestClass
```

### Releasing

The project has been configured to release both plugins to the Gradle Portal and to release to Maven Central.
Expand Down

0 comments on commit 73c54e5

Please sign in to comment.