Merge pull request #1339 from LemonAppDev/develop

`develop` to `main`

.github/workflows/check-ktdoc-snippets.yml

@@ -26,7 +26,7 @@ jobs:
 
       - name: Get Changed Files
         id: changed-files
-        uses: tj-actions/[email protected].0
+        uses: tj-actions/[email protected].1
 
       - name: Echo List Changed Files
         run: |

.github/workflows/check-kttest-snippets.yml

@@ -26,7 +26,7 @@ jobs:
 
       - name: Get Changed Files
         id: changed-files
-        uses: tj-actions/[email protected].0
+        uses: tj-actions/[email protected].1
 
       - name: Echo List Changed Files
         run: |

.github/workflows/check-starter-projects.yml

@@ -26,7 +26,7 @@ jobs:
 
       - name: Get Changed Files
         id: changed-files
-        uses: tj-actions/[email protected].0
+        uses: tj-actions/[email protected].1
 
       - name: List Changed Files
         run: |

.gitignore

@@ -7,6 +7,9 @@ target/
 build/
 .gradle/
 
+# Kotlin
+.kotlin/
+
 # IntelliJ IDEA Files
 .idea
 

DeveloperReadme.md

@@ -18,57 +18,28 @@
   artefact will be transferred to [maven central](https://central.sonatype.com/artifact/com.lemonappdev/konsist)
   repository after some time.
 
+## Production Release
+
+1. Run `/scripts/create_release.py` script
+2. Select option `1` on the console
+3. (If needed) Remove deprecated API
+4. Run `./gradlew publish -Pkonsist.releaseTarget=release` on the `main` branch to release a new version 
+5. (If needed) Change `Fix versions` for unfinished tickets assigned to this release version
+6. Notify the community about the release 
+7. Notify devs who have reported the issue or asked for the new feature (community links in original ticket)
+
 ## Hotfix Release
 
 1. Create `hotfix/KON-XXX-...` branch from `main`
-2. Fix the bug and open PR targeting `mian`
+2. Fix the bug and open PR targeting `main`
 3. Merge the PR
-4. Create `release/vX.Y.Z` branch from `main`
-5. Update Konsist version
-    1. [gradle.properties](gradle.properties) file
-    2. [README.md](README.md) file
-    3. Sample projects
-6. Open the release PR targeting `main` and wait for all checks to pass
-7. Merge PR
-8. Switch to the `main` branch and pull changes
-9. Run `./gradlew publish -Pkonsist.releaseTarget=release` on the `main` branch to release a new version
-10. Create a new [GitHub release](https://github.com/LemonAppDev/konsist/releases/new)
-    1. set `vX.Y.Z` as tag version
-    2. set `vX.Y.Z` as release title
-11. Update Konsist version in the
-    Konsist [Quick Start](https://app.gitbook.com/o/PQj191UX5M2C2XxCZuYO/s/RYeSMx6WDKivnwWx7PdP/getting-started/getting-started)
-    docs page
-12. Run `/scripts/deploy_snippets_to_kotlin_documentation_repo.py` snippet to generate PR with updated snippets for Konsist Documentation
-13. Merge `main` to `develop`
-14. Upgrade `konist` version on `develop` branch
-15. Notify devs who have reported the issue (community link in original ticket)
-
-## Production Release
+4. Run `/scripts/create_release.py` script
+5. Select option `2` on the console
+6. (If needed) Remove deprecated API
+7. Run `./gradlew publish -Pkonsist.releaseTarget=release` on the `main` branch to release a new version
+8. Notify the community about the release
+9. Notify devs who have reported the issue (community link in original ticket)
 
-1. Merge `main` to `develop`
-2. Create `release/vX.Y.Z` branch from `develop`
-3. Update Konsist version
-    1. [gradle.properties](gradle.properties) file
-    2. [README.md](README.md) file
-4. Remove deprecated API
-5. Open PR targeting `main` and wait for all checks to pass
-6. Release local artifact and test 3rd party projects using local artifact
-    1. [Android-showcase](https://github.com/igorwojda/android-showcase)
-    2. Mango (internal)
-    3. [CleanArchitectureForAndroid](https://github.com/EranBoudjnah/CleanArchitectureForAndroid)
-7. Merge PR to `main`
-8. Run `./gradlew publish -Pkonsist.releaseTarget=release` on the `main` branch to release a new version
-9. Create a new [GitHub release](https://github.com/LemonAppDev/konsist/releases/new)
-    1. set `vX.Y.Z` as tag version
-    2. set `vX.Y.Z` as release title
-10. Update Konsist version in the
-    Konsist [Quick Start](https://app.gitbook.com/o/PQj191UX5M2C2XxCZuYO/s/RYeSMx6WDKivnwWx7PdP/getting-started/gettingstarted)
-    docs page
-11. Run `/scripts/deploy_snippets_to_kotlin_documentation_repo.py` snippet to generate PR with updated snippets for
-    Konsist Documentation
-12. Merge `main` to `develop` (`release` branch will have changes e.g. version, deprecated APi removed...)
-13. Notify the community about the release
-14. Notify devs who have reported the issue or asked for the new feature (community links in original ticket)
 
 ## Sonatype
 

gradle/libs.versions.toml

@@ -25,4 +25,4 @@ kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlinVersion" }
 dokka = "org.jetbrains.dokka:1.9.20"
 spotless = "com.diffplug.spotless:6.25.0"
 testLogger = "com.adarshr.test-logger:4.0.0"
-detekt = "io.gitlab.arturbosch.detekt:1.23.6"
+detekt = "io.gitlab.arturbosch.detekt:1.23.7"

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.10-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.1-bin.zip
 networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

lib/src/integrationTest/kotlin/com/lemonappdev/konsist/core/declaration/kofunction/KoFunctionDeclarationForKoFullyQualifiedNameProviderTest.kt

@@ -38,7 +38,7 @@ class KoFunctionDeclarationForKoFullyQualifiedNameProviderTest {
                 .first()
 
         // then
-        sut.fullyQualifiedName shouldBeEqualTo "com.samplepackage.SampleClass.sampleFunction"
+        sut.fullyQualifiedName shouldBeEqualTo null
     }
 
     @Test
@@ -50,7 +50,7 @@ class KoFunctionDeclarationForKoFullyQualifiedNameProviderTest {
                 .first()
 
         // then
-        sut.fullyQualifiedName shouldBeEqualTo "SampleClass.sampleFunction"
+        sut.fullyQualifiedName shouldBeEqualTo null
     }
 
     private fun getSnippetFile(fileName: String) =

lib/src/integrationTest/kotlin/com/lemonappdev/konsist/core/declaration/koparameter/KoParameterDeclarationForKoContainingDeclarationProviderTest.kt

@@ -1,7 +1,9 @@
 package com.lemonappdev.konsist.core.declaration.koparameter
 
 import com.lemonappdev.konsist.TestSnippetProvider.getSnippetKoScope
-import org.amshove.kluent.shouldNotBeEqualTo
+import com.lemonappdev.konsist.api.declaration.KoClassDeclaration
+import com.lemonappdev.konsist.api.declaration.KoFunctionDeclaration
+import org.amshove.kluent.shouldBeInstanceOf
 import org.junit.jupiter.api.Test
 
 class KoParameterDeclarationForKoContainingDeclarationProviderTest {
@@ -17,7 +19,7 @@ class KoParameterDeclarationForKoContainingDeclarationProviderTest {
                 ?.first()
 
         // then
-        sut?.containingDeclaration shouldNotBeEqualTo null
+        sut?.containingDeclaration?.shouldBeInstanceOf(KoClassDeclaration::class)
     }
 
     @Test
@@ -31,7 +33,7 @@ class KoParameterDeclarationForKoContainingDeclarationProviderTest {
                 .first()
 
         // then
-        sut.containingDeclaration shouldNotBeEqualTo null
+        sut.containingDeclaration.shouldBeInstanceOf(KoFunctionDeclaration::class)
     }
 
     private fun getSnippetFile(fileName: String) =

lib/src/integrationTest/kotlin/com/lemonappdev/konsist/core/declaration/koproperty/KoPropertyDeclarationForKoFullyQualifiedNameProviderTest.kt

@@ -38,7 +38,7 @@ class KoPropertyDeclarationForKoFullyQualifiedNameProviderTest {
                 .first()
 
         // then
-        sut.fullyQualifiedName shouldBeEqualTo "com.samplepackage.SampleClass.sampleProperty"
+        sut.fullyQualifiedName shouldBeEqualTo null
     }
 
     @Test
@@ -50,7 +50,7 @@ class KoPropertyDeclarationForKoFullyQualifiedNameProviderTest {
                 .first()
 
         // then
-        sut.fullyQualifiedName shouldBeEqualTo "SampleClass.sampleProperty"
+        sut.fullyQualifiedName shouldBeEqualTo null
     }
 
     private fun getSnippetFile(fileName: String) =