Skip to content

Commit 5df7444

Browse files
authored
docs: add instructions for running tests (GoogleCloudPlatform#118)
* 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>
1 parent 82401c7 commit 5df7444

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,44 @@ information on using pull requests.
2626

2727
This project follows [Google's Open Source Community
2828
Guidelines](https://opensource.google.com/conduct/).
29+
30+
## Developing
31+
32+
This project is divided into multiple packages, primarily:
33+
34+
- [`functions-framework-api`](./functions-framework-api)
35+
- `core`
36+
- `testfunction`
37+
- `function-maven-plugin`
38+
- `conformance`
39+
- [`java-function-invoker`](./invoker)
40+
41+
### Setup JDK 11 / 17
42+
43+
Install JDK 11 and 17. One way to install these is through [SDK man](https://sdkman.io/).
44+
45+
```sh
46+
sdk install java 11.0.2-open
47+
sdk install java 17
48+
sdk use java 17
49+
sdk use java 11.0.2-open
50+
```
51+
52+
Verify Java version with:
53+
54+
```sh
55+
java --version
56+
```
57+
58+
### Setup Apache Maven
59+
60+
Install `mvn`:
61+
62+
https://maven.apache.org/install.html
63+
64+
## Install and Run Invoker Tests Locally
65+
66+
```
67+
cd invoker;
68+
mvn test;
69+
```

0 commit comments

Comments
 (0)