Skip to content

Commit

Permalink
Overhaul of Maven files + initial CONTRIBUTING.md (AdoptOpenJDK#197)
Browse files Browse the repository at this point in the history
* overhaul of Maven files

* move execution out of mgmt

* initial contributing guide

* rollback maven install upgrade
  • Loading branch information
karianna committed May 2, 2020
1 parent 37567ef commit 887bf1d
Show file tree
Hide file tree
Showing 5 changed files with 502 additions and 97 deletions.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
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
6 changes: 2 additions & 4 deletions adoptopenjdk-api-v3-frontend/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,6 @@
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
</dependency>


<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-junit5</artifactId>
Expand Down Expand Up @@ -221,7 +219,7 @@
<plugin>
<groupId>io.swagger</groupId>
<artifactId>swaggerhub-maven-plugin</artifactId>
<version>1.0.7</version>
<version>1.0.8</version>
<configuration>
<api>API</api>
<owner>AdoptOpenJDK</owner>
Expand All @@ -235,7 +233,7 @@
<plugin>
<groupId>org.openapitools</groupId>
<artifactId>openapi-generator-maven-plugin</artifactId>
<version>4.2.2</version>
<version>4.3.0</version>
<configuration>
<generatorName>javascript</generatorName>
</configuration>
Expand Down
5 changes: 0 additions & 5 deletions adoptopenjdk-api-v3-updater/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,6 @@
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jsr353</artifactId>
</dependency>


<dependency>
<groupId>org.litote.kmongo</groupId>
<artifactId>kmongo-flapdoodle</artifactId>
Expand Down Expand Up @@ -137,12 +135,10 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.22.2</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>2.6</version>
<configuration>
<archive>
<manifest>
Expand All @@ -155,7 +151,6 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<version>2.6</version>
<executions>
<execution>
<id>make-assembly</id>
Expand Down
3 changes: 2 additions & 1 deletion gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-5.5.1-bin.zip
#distributionUrl=https\://services.gradle.org/distributions/gradle-5.5.1-bin.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.4-bin.zip
Loading

0 comments on commit 887bf1d

Please sign in to comment.