Skip to content

Commit

Permalink
docs: add instructions for running tests (GoogleCloudPlatform#118)
Browse files Browse the repository at this point in the history
* docs: add instructions for running tests

Signed-off-by: Grant Timmerman <timmerman+devrel@google.com>

* docs: update contributing

Signed-off-by: Grant Timmerman <timmerman+devrel@google.com>
  • Loading branch information
grant authored Oct 12, 2021
1 parent 82401c7 commit 5df7444
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,44 @@ information on using pull requests.

This project follows [Google's Open Source Community
Guidelines](https://opensource.google.com/conduct/).

## Developing

This project is divided into multiple packages, primarily:

- [`functions-framework-api`](./functions-framework-api)
- `core`
- `testfunction`
- `function-maven-plugin`
- `conformance`
- [`java-function-invoker`](./invoker)

### Setup JDK 11 / 17

Install JDK 11 and 17. One way to install these is through [SDK man](https://sdkman.io/).

```sh
sdk install java 11.0.2-open
sdk install java 17
sdk use java 17
sdk use java 11.0.2-open
```

Verify Java version with:

```sh
java --version
```

### Setup Apache Maven

Install `mvn`:

https://maven.apache.org/install.html

## Install and Run Invoker Tests Locally

```
cd invoker;
mvn test;
```

0 comments on commit 5df7444

Please sign in to comment.