archetype-resources.DEVELOPMENT.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kotlin-application-maven-archetype

Maven archetype for building Kotlin applications

There is a newer version: 5.0.0

#set($h1 = '#')
#set($h2 = '##')
#set($h3 = '###')
#set($h4 = '####')
$h1 ${projectName}

$h2 Requirements

* Java 8
* Direct internet access / Apache Maven proxy configured

$h3 Changing the required Java version

Java 8 is required by default. To move the project to Java 11, change the following two properties
in your `pom.xml`:

```xml

  ...
  12
  11
  ...

```

$h2 Building

This project is built using [Maven Wrapper](https://github.com/takari/maven-wrapper).

$h3 Building Java only (no Docker image)

$h4 Linux/macOS

```bash
./mvnw install
```

$h4 Windows

```bash
mvnw.cmd install
```

$h3 Building to your local Docker daemon

$h4 Linux/macOS

```bash
./mvnw install -P docker-local
```

$h4 Windows

```bash
mvnw.cmd install -P docker-local
```

$h3 Building to a remote Docker registry

First you need to change the `docker.image` property in the `pom.xml` to specify the registry.

```xml

  ...
  e.g. gcr.io/my-gcp-project/my-app
  ...

```

You'll likely need to authenticate with your Docker registry, follow the
[instructions here](https://github.com/GoogleContainerTools/jib/tree/master/jib-maven-plugin#authentication-methods).

Once you've configured the authentication for your Docker registry run the following command to
build and push the Docker image (this doesn't require a local Docker daemon):

$h4 Linux/macOS

```bash
./mvnw install -P docker-registry
```

$h4 Windows

```bash
mvnw.cmd install -P docker-registry
```

$h2 Security scanning

This project includes the [SpotBugs Maven Plugin](https://spotbugs.github.io/spotbugs-maven-plugin)
with the [Find Security Bugs](https://find-sec-bugs.github.io) plugin for performing static analysis
on your code. The static analysis can be quite time consuming so it's not run by default.

To run the security scan run the following from the project root:

$h4 Linux/macOS

```bash
./mvnw clean install
./mvnw spotbugs:spotbugs -P find-sec-bugs
```

$h4 Windows

```bash
mvnw.cmd clean install
mvnw.cmd spotbugs:spotbugs -P find-sec-bugs
```

To view the results run the following from each Maven module directory:

$h4 Linux/macOS

```bash
./mvnw spotbugs:gui -P find-sec-bugs
```

$h4 Windows

```bash
mvnw.cmd spotbugs:gui -P find-sec-bugs
```