diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a14aabe..49c742e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,3 +16,4 @@ Thank you for investing your time and effort in contributing to my project, I ap - **Code Style**: Follow the existing code style present in the project. - **Discuss Large Features**: Large features should be discussed with maintainers before implementation. - **Thread Safety**: Ensure that the code you write is thread-safe. + diff --git a/README.md b/README.md index 1560097..2bba4b6 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,9 @@ # awesome-kotlin-maven-template - [![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) - ## How to run Create `.env` file in root directory and add your API keys: @@ -15,14 +13,18 @@ OPENAI_API_KEY=sk-xxxxx ``` Building project locally: + ```shell mvn clean verify ``` + or using Make + ```shell make build ``` ## Contributing + We welcome contributions! Please see the [Contributing Guidelines](CONTRIBUTING.md) for details. diff --git a/RELEASE.md b/RELEASE.md index 58239ec..e1e4fb5 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -2,41 +2,42 @@ 1. Cleanup - ```shell - mvn release:clean - ``` + ```shell + mvn release:clean + ``` + delete git tag, if needed: - ```shell - git tag -d v0.1.0 - ``` + ```shell + git tag -d v0.1.0 + ``` 2. Prepare the release: - ```shell - mvn release:prepare \ - -Dresume=false \ - -DpushChanges=false - ``` + ```shell + mvn release:prepare \ + -Dresume=false \ + -DpushChanges=false + ``` 3. Perform the release - ```shell - GPG_TTY=$(tty) && \ - export GPG_TTY && \ - mvn release:perform -DlocalCheckout=true - ``` - https://stackoverflow.com/a/57591830/3315474 - + ```shell + GPG_TTY=$(tty) && \ + export GPG_TTY && \ + mvn release:perform -DlocalCheckout=true + ``` + https://stackoverflow.com/a/57591830/3315474 - In case of GPG error `gpg: signing failed: Screen or window too small`, [try this](https://stackoverflow.com/a/67498543/3315474): - ```shell - gpg -K --keyid-format SHORT - ``` +In case of GPG error `gpg: signing failed: Screen or window too small`, [try this](https://stackoverflow.com/a/67498543/3315474): +```shell +gpg -K --keyid-format SHORT +``` 4. Push - ```shell - git push origin - git push origin --tags - ``` + ```shell + git push origin + git push origin --tags + ``` + diff --git a/bom/pom.xml b/bom/pom.xml index 58831d1..a723ba9 100644 --- a/bom/pom.xml +++ b/bom/pom.xml @@ -1,7 +1,5 @@ - + 4.0.0 me.kpavlov.project @@ -14,8 +12,7 @@ pom Project :: BOM - Bill of Materials POM for getting full, complete set of compatible versions of project modules - + Bill of Materials POM for getting full, complete set of compatible versions of project modules diff --git a/core/pom.xml b/core/pom.xml index a023ff7..ff8d2b1 100644 --- a/core/pom.xml +++ b/core/pom.xml @@ -1,7 +1,5 @@ - + 4.0.0 me.kpavlov.project diff --git a/pom.xml b/pom.xml index 6476e07..d6f666f 100644 --- a/pom.xml +++ b/pom.xml @@ -214,12 +214,17 @@ - + + **/*.md + + + **/pom.xml + 4 false diff --git a/reports/pom.xml b/reports/pom.xml index 639bb8f..9423249 100644 --- a/reports/pom.xml +++ b/reports/pom.xml @@ -1,7 +1,5 @@ - + 4.0.0 me.kpavlov.project @@ -32,6 +30,23 @@ org.jetbrains.kotlinx kover-maven-plugin + + + true + CLASS + true + + + CLASS + + + COVERED_COUNT + 100 + + + + + kover-xml @@ -52,23 +67,6 @@ - - - true - CLASS - true - - - CLASS - - - COVERED_COUNT - 100 - - - - -