Skip to content

Commit

Permalink
Add Dokka to build process and update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Konstantin Pavlov authored and Konstantin Pavlov committed Dec 2, 2024
1 parent 9a0ba84 commit 47978b9
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 1 deletion.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,24 @@ Thank you for investing your time and effort in contributing to my project, I ap
- **Discuss Large Features**: Large features should be discussed with maintainers before implementation.
- **Thread Safety**: Ensure that the code you write is thread-safe.

## Using the Makefile

The [`Makefile`](Makefile) includes several helpful targets to make your development process more efficient:

- **`build`**:
- Runs all tests, verifies the project, and generates site documentation.

- **`apidocs`**:
- Generates API documentation using Dokka and places it in `target/docs/api`.

- **`lint`**:
- Prepares the environment and checks code style using `ktlint` and Maven `spotless:check`.

- **`format`**:
- Formats the code using `ktlint --format` and applies `spotless` and OpenRewrite best practices.

- **`prepare`**:
- Installs `ktlint` via Homebrew if not already installed.

- **`all`**:
- Executes `format`, `lint`, and `build` sequentially.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
build:
mvn clean verify site
mvn clean verify dokka:dokka site

apidocs:
mvn clean dokka:dokka -pl !reports && \
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
[![Kotlin CI with Maven](https://github.com/kpavlov/awesome-kotlin-maven-template/actions/workflows/maven.yml/badge.svg?branch=main)](https://github.com/kpavlov/awesome-kotlin-maven-template/actions/workflows/maven.yml)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/4da0f1abf0fd49038bb29676b6d38579)](https://app.codacy.com/gh/kpavlov/awesome-kotlin-maven-template/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[![Codacy Coverage](https://app.codacy.com/project/badge/Coverage/4da0f1abf0fd49038bb29676b6d38579)](https://app.codacy.com/gh/kpavlov/awesome-kotlin-maven-template/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
[![Api Docs](https://img.shields.io/badge/api-docs-blue)](https://kpavlov.github.io/awesome-kotlin-maven-template/api/)

## How to run

Expand Down

0 comments on commit 47978b9

Please sign in to comment.