forked from AdoptOpenJDK/openjdk-api-v3
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Overhaul of Maven files + initial CONTRIBUTING.md (AdoptOpenJDK#197)
* overhaul of Maven files * move execution out of mgmt * initial contributing guide * rollback maven install upgrade
- Loading branch information
Showing
5 changed files
with
502 additions
and
97 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Contributing to AdoptOpenJDK API (V3) | ||
|
||
## Overview | ||
|
||
The AdoptOpenJDK API V3 is a Kotlin application (fronted by Swagger and OpenAPI) which makes | ||
calls via the GitHub API inb order to retrieve AdoptOpenJDK binaries and metadata. | ||
|
||
Since the GitHub API is rate limited we use MongoDB as a caching mechanism. | ||
|
||
## Build | ||
|
||
### Pre-Requisites | ||
|
||
Java 11 is required to build. | ||
|
||
### Build Tool | ||
|
||
We use a Maven Wrapper (mvnw) to ensure that there's a consistent repeatable build. | ||
|
||
### Build | ||
|
||
`./mvnw clean install` | ||
|
||
## Usage | ||
|
||
The api is documented via swagger. The swagger documentation can be viewed at: [swagger-ui](https://api.adoptopenjdk.net/swagger-ui). | ||
The open api definition for this can be viewed at [openapi](https://api.adoptopenjdk.net/openapi). | ||
|
||
## Deployment | ||
|
||
The API is deployed to Red Hat OpenShift. | ||
|
||
The API is CDN fronted by Cloud Flare |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.