Skip to content

ISSUE-4627: Update documentation to fix "Incorrect version in documentation" #4811

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 14 commits into from
Apr 12, 2025
Merged

ISSUE-4627: Update documentation to fix "Incorrect version in documentation" #4811

merged 14 commits into from
Apr 12, 2025

Conversation

metters
Copy link
Contributor

@metters metters commented Mar 16, 2025 •
edited
Loading

Changes

As suggested in the discussion of the issue here I added a placeholder for the minor versions:
Screenshot 2025-03-16 at 20 15 28

I have not added a link to Maven Central as suggested here. Please provide some text and I will gladly add it to the page.

The pull request template states

If this PR updates documentation, please update all relevant versions of the docs, see: https://github.com/kotest/kotest/tree/master/documentation/versioned_docs

Therefore, I did this for all versions in the documentation: from 5.2 until 5.9

Please let me know if there are other folders or text to update for uniformity!

Some concerns

I also check what the change looks like by running the site locally.

  • Should 5.9 🚧 be updated to 5.9.x 🚧 ?
  • Are we sure, the additional x does not lead to confusion?
Screenshot 2025-03-16 at 20 23 49 Screenshot 2025-03-16 at 20 23 55

Additional updates

Additionally I fixed some typos and unified the spelling of multi-platform/multi platform/multiplatform

I separated the changes by commit which might help when reviewing the pull request.

EDIT

I just saw, how many files are affected by unifying the spelling of multiplatform. Most times the spelling was multi-platform. Please let me know if I should make it uniformlymulti-plaform instead!

@metters metters requested a review from a team as a code owner March 16, 2025 19:35
@sksamuel
Copy link
Member

lgtm

@sksamuel sksamuel enabled auto-merge March 23, 2025 03:04
@metters
Copy link
Contributor Author

metters commented Mar 23, 2025 •
edited
Loading

This might be a dumb question, but did those gradle checks fail due to changes by me?
If I run ./gradlew kotest-extensions:jvmMaxJdkTest (just as an example for one of the failing tasks) on my local machine on the latest master, the task fails too:

➜  kotest git:(master) ./gradlew kotest-extensions:jvmMaxJdkTest
Type-safe project accessors is an incubating feature.

> Configure project :kotest-framework:kotest-framework-standalone
w: 'java-library' (also applies 'java' plugin) Gradle plugin is not compatible with 'org.jetbrains.kotlin.multiplatform' plugin.

Consider adding a new subproject with 'java-library' plugin where the KMP project is added as a dependency.

w: 'java' Gradle plugin is not compatible with 'org.jetbrains.kotlin.multiplatform' plugin.

Consider adding a new subproject with 'java' plugin where the KMP project is added as a dependency.

w: 'application' (also applies 'java' plugin) Gradle plugin is not compatible with 'org.jetbrains.kotlin.multiplatform' plugin.

Consider adding a new subproject with 'application' plugin where the KMP project is added as a dependency.


> Task :kotest-extensions:jvmMaxJdkTest FAILED

com.sksamuel.kt.extensions.system.SystemEnvironmentExtensionTest[jvm]

  Should return original environment to its place after execution[jvm]

    Test String String overload[jvm] FAILED

    java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5
        at com.sksamuel.kt.extensions.system.SystemEnvironmentExtensionTest.executeOnAllEnvironmentOverloads(SystemEnvironmentExtensionTest.kt:49)
    Caused by: java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5
        at com.sksamuel.kt.extensions.system.SystemEnvironmentExtensionTest.executeOnAllEnvironmentOverloads(SystemEnvironmentExtensionTest.kt:49)

    Test Pair overload[jvm] FAILED

    java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5
        at com.sksamuel.kt.extensions.system.SystemEnvironmentExtensionTest.executeOnAllEnvironmentOverloads(SystemEnvironmentExtensionTest.kt:53)
    Caused by: java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5
        at com.sksamuel.kt.extensions.system.SystemEnvironmentExtensionTest.executeOnAllEnvironmentOverloads(SystemEnvironmentExtensionTest.kt:53)

    Test Map overload[jvm] FAILED

    java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5
        at com.sksamuel.kt.extensions.system.SystemEnvironmentExtensionTest.executeOnAllEnvironmentOverloads(SystemEnvironmentExtensionTest.kt:57)
    Caused by: java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5
        at com.sksamuel.kt.extensions.system.SystemEnvironmentExtensionTest.executeOnAllEnvironmentOverloads(SystemEnvironmentExtensionTest.kt:57)


  Should set environment to specific map[jvm]

    Test String String overload[jvm] FAILED

    java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5
        at com.sksamuel.kt.extensions.system.SystemEnvironmentExtensionTest.executeOnAllEnvironmentOverloads(SystemEnvironmentExtensionTest.kt:49)
    Caused by: java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5
        at com.sksamuel.kt.extensions.system.SystemEnvironmentExtensionTest.executeOnAllEnvironmentOverloads(SystemEnvironmentExtensionTest.kt:49)

    Test Pair overload[jvm] FAILED

    java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5
        at com.sksamuel.kt.extensions.system.SystemEnvironmentExtensionTest.executeOnAllEnvironmentOverloads(SystemEnvironmentExtensionTest.kt:53)
    Caused by: java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5
        at com.sksamuel.kt.extensions.system.SystemEnvironmentExtensionTest.executeOnAllEnvironmentOverloads(SystemEnvironmentExtensionTest.kt:53)

    Test Map overload[jvm] FAILED

    java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5
        at com.sksamuel.kt.extensions.system.SystemEnvironmentExtensionTest.executeOnAllEnvironmentOverloads(SystemEnvironmentExtensionTest.kt:57)
    Caused by: java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5
        at com.sksamuel.kt.extensions.system.SystemEnvironmentExtensionTest.executeOnAllEnvironmentOverloads(SystemEnvironmentExtensionTest.kt:57)


  Should return the computed value[jvm]

    Test String String overload[jvm] FAILED

    java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5
        at com.sksamuel.kt.extensions.system.SystemEnvironmentExtensionTest.executeOnAllEnvironmentOverloads(SystemEnvironmentExtensionTest.kt:49)
    Caused by: java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5
        at com.sksamuel.kt.extensions.system.SystemEnvironmentExtensionTest.executeOnAllEnvironmentOverloads(SystemEnvironmentExtensionTest.kt:49)

    Test Pair overload[jvm] FAILED

    java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5
        at com.sksamuel.kt.extensions.system.SystemEnvironmentExtensionTest.executeOnAllEnvironmentOverloads(SystemEnvironmentExtensionTest.kt:53)
    Caused by: java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5
        at com.sksamuel.kt.extensions.system.SystemEnvironmentExtensionTest.executeOnAllEnvironmentOverloads(SystemEnvironmentExtensionTest.kt:53)

    Test Map overload[jvm] FAILED

    java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5
        at com.sksamuel.kt.extensions.system.SystemEnvironmentExtensionTest.executeOnAllEnvironmentOverloads(SystemEnvironmentExtensionTest.kt:57)
    Caused by: java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5
        at com.sksamuel.kt.extensions.system.SystemEnvironmentExtensionTest.executeOnAllEnvironmentOverloads(SystemEnvironmentExtensionTest.kt:57)


com.sksamuel.kt.extensions.system.SystemEnvironmentTestListenerTest[jvm]

  Test sys environment extension should[jvm] FAILED

  io.kotest.engine.extensions.ExtensionException$BeforeSpecException: java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5

  Caused by: java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5
      at com.sksamuel.kt.extensions.system.SystemEnvironmentTestListenerTest.beforeSpec(SystemEnvironmentExtensionTest.kt:79)

  Test Before Spec Error[jvm] FAILED

  java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5
      at com.sksamuel.kt.extensions.system.SystemEnvironmentTestListenerTest.beforeSpec(SystemEnvironmentExtensionTest.kt:79)

  Test executionError[jvm] FAILED

  io.kotest.engine.extensions.ExtensionException$BeforeSpecException: java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5

  Caused by: java.lang.reflect.InaccessibleObjectException: Unable to make field final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @293bb8a5
      at com.sksamuel.kt.extensions.system.SystemEnvironmentTestListenerTest.beforeSpec(SystemEnvironmentExtensionTest.kt:79)


com.sksamuel.kt.extensions.system.SystemExitTest[jvm]

  Test System exit should throw an exception when the listener is added[jvm] FAILED

  io.kotest.engine.extensions.ExtensionException$BeforeSpecException: java.lang.UnsupportedOperationException: The Security Manager is deprecated and will be removed in a future release

  Caused by: java.lang.UnsupportedOperationException: The Security Manager is deprecated and will be removed in a future release


  Test SpecSystemExitListener should expose last exit code[jvm] SKIPPED
  Test Before Spec Error[jvm] FAILED

  java.lang.UnsupportedOperationException: The Security Manager is deprecated and will be removed in a future release


  Test executionError[jvm] FAILED

  io.kotest.engine.extensions.ExtensionException$BeforeSpecException: java.lang.UnsupportedOperationException: The Security Manager is deprecated and will be removed in a future release

  Caused by: java.lang.UnsupportedOperationException: The Security Manager is deprecated and will be removed in a future release



FAILURE: Executed 50 tests in 1.5s (15 failed, 1 skipped)


50 tests completed, 15 failed, 1 skipped

[Incubating] Problems report is available at: file:///Users/me/kotest/build/reports/problems/problems-report.html

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':kotest-extensions:jvmMaxJdkTest'.
> There were failing tests. See the report at: file:///Users/me/kotest/kotest-extensions/build/reports/tests/jvmMaxJdkTest/index.html

Deprecated Gradle features were used in this build, making it incompatible with Gradle 9.0.

You can use '--warning-mode all' to show the individual deprecation warnings and determine if they come from your own scripts or plugins.

For more on this, please refer to https://docs.gradle.org/8.12.1/userguide/command_line_interface.html#sec:command_line_warnings in the Gradle documentation.

BUILD FAILED in 4s
25 actionable tasks: 1 executed, 24 up-to-date

@sksamuel sksamuel added this pull request to the merge queue Apr 12, 2025
Merged via the queue into kotest:master with commit 828cee9 Apr 12, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sksamuel sksamuel sksamuel approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@metters @sksamuel @metters-senacor