Skip to content
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

Version 1.1.0 #12

Merged
merged 1 commit into from
Aug 25, 2024
Merged

Version 1.1.0 #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
# Renaming ? Change the README badge.
name: Build
on:
push:
Expand All @@ -17,6 +16,7 @@ jobs:
java-version: 17
distribution: temurin
cache: gradle
- uses: gradle/actions/wrapper-validation@v4
- name: Check local deployment
run: ./gradlew build deployLocal
CHECK_TESTS:
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/snapshot.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
# Renaming ? Change the README badge.
name: Snapshot
on:
push:
Expand Down
2 changes: 1 addition & 1 deletion .idea/kotlinc.xml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[![Build Status](https://github.com/deepmedia/Knee/actions/workflows/build.yml/badge.svg?event=push)](https://github.com/deepmedia/Knee/actions)
[![Release](https://img.shields.io/github/release/deepmedia/Knee.svg)](https://github.com/deepmedia/Knee/releases)
[![Issues](https://img.shields.io/github/issues-raw/deepmedia/MavenDeployer.svg)](https://github.com/deepmedia/Knee/issues)
[![Issues](https://img.shields.io/github/issues-raw/deepmedia/Knee.svg)](https://github.com/deepmedia/Knee/issues)

![Project logo](assets/logo_256.png)

Expand All @@ -23,7 +23,7 @@ pluginManagement {

// build.gradle.kts
plugins {
id("io.deepmedia.tools.knee") version "1.0.0"
id("io.deepmedia.tools.knee") version "1.1.0"
}
```

Expand Down
1 change: 1 addition & 0 deletions docs/concepts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Concepts
description: Discover Knee's main concepts - the motivation behind the plugin and notes about its architecture and design.
---

# Concepts
Expand Down
3 changes: 3 additions & 0 deletions docs/configure.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: Configure
description: >
Check out all available options to configure Knee Gradle Plugin, like verbosity, output directories and automatic
target connection in Kotlin Multiplatform projects.
---

# Configuration
Expand Down
3 changes: 3 additions & 0 deletions docs/features/builtin-types.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: Built-in types
description: >
Understand how Knee compiler plugin can serialize several built-in types from the Kotlin standard library and let
you pass them from Kotlin Native to the JVM and vice versa.
---

# Built-in types
Expand Down
3 changes: 3 additions & 0 deletions docs/features/callables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: Callables
description: >
Learn about the concept of callables in Knee - a set of function and properties that are explicitly marked
to be serializable and represent the links between the Native and JVM part of your Kotlin project.
---

# Callables
Expand Down
3 changes: 3 additions & 0 deletions docs/features/classes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: Classes
description: >
Understand how Knee compiler plugin can serialize declared classes and let you pass them from Kotlin Native
to the JVM and vice versa, including support for externally defined classes.
---

# Classes
Expand Down
3 changes: 3 additions & 0 deletions docs/features/enums.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: Enums
description: >
Understand how Knee compiler plugin can serialize Kotlin enumerations and let you pass them from Kotlin Native
to the JVM and vice versa, including support for externally defined enums.
---

# Enums
Expand Down
3 changes: 3 additions & 0 deletions docs/features/exceptions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: Exceptions
description: >
Learn about how the Knee compiler plugin deals with exceptions across the Kotlin Native / JVM boundary and how you
can define custom, serializable exceptions.
---

# Exceptions
Expand Down
3 changes: 3 additions & 0 deletions docs/features/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: Features
description: >
Discover our comprehensive guide across all Knee compiler plugin features to enable communication between Kotlin Native
and Kotlin JVM in your project.
docs:
- callables
- suspend-functions
Expand Down
3 changes: 3 additions & 0 deletions docs/features/interfaces.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: Interfaces
description: >
Understand how Knee compiler plugin can serialize declared interfaces and let you pass them from Kotlin Native
to the JVM and vice versa, including support for externally defined interfaces.
---

# Interfaces
Expand Down
3 changes: 3 additions & 0 deletions docs/features/suspend-functions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: Suspend functions
description: >
Understand how Knee can provide structured concurrency across the JNI boundary thanks to Kotlin suspend functions,
from Kotlin Native to JVM and vice versa.
---

# Suspend Functions
Expand Down
3 changes: 3 additions & 0 deletions docs/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: Intro
description: >
Knee provides seamless two-way communication between Kotlin/Native and Kotlin/JVM. Supports suspend functions, classes,
interfaces, no-copy buffers and much more.
docs:
- install
- concepts
Expand Down
1 change: 1 addition & 0 deletions docs/initialize.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Initialize
description: Understand all the possible options to initialize Knee at runtime and learn about the concept of KneeModules.
---

# Initialization
Expand Down
5 changes: 4 additions & 1 deletion docs/install.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Install
description: Follow the instructions to download Knee Gradle Plugin and runtime and discover how to install release snapshots.
---

# Installation
Expand All @@ -22,10 +23,12 @@ pluginManagement {

// build.gradle.kts
plugins {
id("io.deepmedia.tools.knee") version "1.0.0"
id("io.deepmedia.tools.knee") version "LATEST_VERSION"
}
```

Replace `LATEST_VERSION` with the desired version number, {version}.

## Snapshots

We regularly push development snapshots of the library at `https://s01.oss.sonatype.org/content/repositories/snapshots/`
Expand Down
1 change: 1 addition & 0 deletions docs/utilities.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Utilities
description: Discover Knee extra utilities that provide a Kotlin-friendly wrapper over JNI APIs at runtime.
---

# Utilities
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ kotlin.mpp.import.enableKgpDependencyResolution=true

android.useAndroidX=true

knee.version=1.0.0
knee.version=1.1.0
knee.group=io.deepmedia.tools.knee
2 changes: 1 addition & 1 deletion tests/test-classes/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
plugins {
kotlin("multiplatform") version "2.0.20"
id("com.android.application") version "8.1.1"
id("io.deepmedia.tools.knee") version "1.0.0"
id("io.deepmedia.tools.knee") version "1.1.0"
}

configurations.configureEach {
Expand Down
2 changes: 1 addition & 1 deletion tests/test-coroutines/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
plugins {
kotlin("multiplatform") version "2.0.20"
id("com.android.application") version "8.1.1"
id("io.deepmedia.tools.knee") version "1.0.0"
id("io.deepmedia.tools.knee") version "1.1.0"
}

configurations.configureEach {
Expand Down
2 changes: 1 addition & 1 deletion tests/test-imports/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
plugins {
kotlin("multiplatform") version "2.0.20"
id("com.android.application") version "8.1.1"
id("io.deepmedia.tools.knee") version "1.0.0"
id("io.deepmedia.tools.knee") version "1.1.0"
}

configurations.configureEach {
Expand Down
2 changes: 1 addition & 1 deletion tests/test-interfaces/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
plugins {
kotlin("multiplatform") version "2.0.20"
id("com.android.application") version "8.1.1"
id("io.deepmedia.tools.knee") version "1.0.0"
id("io.deepmedia.tools.knee") version "1.1.0"
}

configurations.configureEach {
Expand Down
2 changes: 1 addition & 1 deletion tests/test-misc/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
plugins {
kotlin("multiplatform") version "2.0.20"
id("com.android.application") version "8.1.1"
id("io.deepmedia.tools.knee") version "1.0.0"
id("io.deepmedia.tools.knee") version "1.1.0"
}

configurations.configureEach {
Expand Down
2 changes: 1 addition & 1 deletion tests/test-primitives/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
plugins {
kotlin("multiplatform") version "2.0.20"
id("com.android.application") version "8.1.1"
id("io.deepmedia.tools.knee") version "1.0.0"
id("io.deepmedia.tools.knee") version "1.1.0"
}

configurations.configureEach {
Expand Down