Merge pull request #60 from atlassian-labs/main

Release version 1.1.5

.editorconfig

@@ -18,23 +18,19 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-# To override IDEA default 120 columns
-max_line_length = 160
-ij_visual_guides = 140, 160
+max_line_length = 120
 
 [*.md]
 trim_trailing_whitespace = false
 
-
 [*.{kt,java}]
 ij_kotlin_imports_layout = *
-indent_size = 4
 ij_kotlin_name_count_to_use_star_import = 999
 ij_kotlin_name_count_to_use_star_import_for_members = 999
 ij_java_class_count_to_use_import_on_demand = 999
 ktlint_standard_trailing-comma-on-call-site=disabled
 ktlint_standard_trailing-comma-on-declaration-site=disabled
-ktlint_function_signature_wrapping_rule_always_with_minimum_parameters = 3
+ktlint_code_style = android_studio
 
 [*.kts]
 ij_kotlin_imports_layout = *

.github/workflows/publish.yml

@@ -37,7 +37,7 @@ jobs:
 
       # Tags the current commit with the version number
       - name: Create tag
-        uses: actions/github-script@v5
+        uses: actions/github-script@v7
         with:
           script: |
             github.rest.git.createRef({

CONTRIBUTING.md

@@ -21,7 +21,7 @@ Prior to accepting your contributions we ask that you please follow the appropri
 To create a release, follow these steps:
 1. Update the version in the `version.properties` file.
 2. Create a PR with these changes, targeting the `main` branch.
-3. Once the PR is merged, create a PR to merge `main` into `release` branch.
+3. Once the PR is merged, create a PR to merge `main` into `release` branch. Make sure to use the `Merge pull request` button to merge the PR (do not use `Squash and merge`).
 4. Once the 2nd PR is merged, the CI/CD pipeline will:
    1. Tag the commit with the new version.
    2. Create a Github release.

build.gradle.kts

@@ -26,7 +26,7 @@ dependencies {
 }
 
 val versionProperties = Properties()
-versionProperties.load(FileInputStream("version.properties"))
+versionProperties.load(FileInputStream("$projectDir/version.properties"))
 
 allprojects {
   group = "com.atlassian.prosemirror"
@@ -38,17 +38,17 @@ subprojects {
   apply(plugin = "signing")
   apply(plugin = "org.jetbrains.dokka") // TODO: use alias
 
+  val srcUrl = "https://github.com/atlassian-labs/prosemirror-kotlin/tree/main/${project.name}/"
   afterEvaluate { // afterEvaluate so that project.ext values will be available
     project.tasks.dokkaHtml {
       dokkaSourceSets {
-        val urlPrefix = project.ext.get("srcUrl") as String
         val commonMain by getting {
           sourceLink {
             // Unix based directory relative path to the root of the project (where you execute gradle respectively).
             localDirectory.set(file("src/commonMain/kotlin"))
 
             // URL showing where the source code can be accessed through the web browser
-            remoteUrl.set(URL("${urlPrefix}src/main/src/commonMain/kotlin"))
+            remoteUrl.set(URL("${srcUrl}src/main/src/commonMain/kotlin"))
 
             // Suffix which is used to append the line number to the URL. Use #L for GitHub
             remoteLineSuffix.set("#lines-")
@@ -61,7 +61,7 @@ subprojects {
             localDirectory.set(file("src/jvmMain/kotlin"))
 
             // URL showing where the source code can be accessed through the web browser
-            remoteUrl.set(URL("${urlPrefix}src/main/src/jvmMain/kotlin"))
+            remoteUrl.set(URL("${srcUrl}src/main/src/jvmMain/kotlin"))
 
             // Suffix which is used to append the line number to the URL. Use #L for GitHub
             remoteLineSuffix.set("#lines-")
@@ -74,7 +74,7 @@ subprojects {
             localDirectory.set(file("src/nativeMain/kotlin"))
 
             // URL showing where the source code can be accessed through the web browser
-            remoteUrl.set(URL("${urlPrefix}src/main/src/nativeMain/kotlin"))
+            remoteUrl.set(URL("${srcUrl}src/main/src/nativeMain/kotlin"))
 
             // Suffix which is used to append the line number to the URL. Use #L for GitHub
             remoteLineSuffix.set("#lines-")
@@ -89,7 +89,7 @@ subprojects {
           pom {
             name.set(project.name)
             description.set(project.ext.get("pomDescription") as String)
-            url.set(project.ext.get("srcUrl") as String)
+            url.set(srcUrl)
 
             scm {
               connection.set("git@github.com:atlassian-labs/prosemirror-kotlin.git")

collab/README.md

@@ -1,3 +1,7 @@
 This module implements an API into which a communication channel for
 collaborative editing can be hooked. See
 [the guide](/docs/guide/#collab) for more details and an example.
+
+## Versioning
+This module is a port of version [1.3.0](https://github.com/ProseMirror/prosemirror-collab/releases/tag/1.3.0)
+of prosemirror-collab

collab/build.gradle.kts

@@ -15,7 +15,7 @@ kotlin {
   }
 
   // iOS
-  val xcframeworkName = "collab"
+  val xcframeworkName = project.name
   val xcf = XCFramework(xcframeworkName)
   listOf(
     iosX64(),
@@ -37,13 +37,13 @@ kotlin {
       implementation(project(":transform"))
     }
     commonTest.dependencies {
+      implementation(project(":history"))
       implementation(project(":test-builder"))
       implementation(libs.kotlin.test)
       implementation(libs.test.assertk)
     }
   }
 }
 
-description = "prosemirror-state"
+description = "prosemirror-collab"
 ext.set("pomDescription", "Collaborative editing for ProseMirror")
-ext.set("srcUrl", "https://github.com/atlassian-labs/prosemirror-kotlin/tree/main/collab/")