Skip to content

Commit

Permalink
Merge pull request #14 from collectiveidea/prep-v0.4.0-release
Browse files Browse the repository at this point in the history
Prep v0.4.0 release
  • Loading branch information
darronschall authored Sep 3, 2024
2 parents 77a606b + 3da9380 commit 741ad1d
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 8 deletions.
7 changes: 6 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

## [Unreleased]

### Changed
## [0.4.0] - 2024-09-03

### Added

* Runtime - Add additional targets (`js`, `jvm`, etc) (see [#13](https://github.com/collectiveidea/twirp-kmm/pull/13))

### Changed

* Runtime - Enabled Explicit API mode (see [#11](https://github.com/collectiveidea/twirp-kmm/pull/11)). This
might hide some of our internal library helpers from downstream consumers.
* Update dependencies
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,20 @@ In general, follow [PBandK Usage](https://github.com/streem/pbandk#usage) instru

### Usage

Download the latest release, currently `0.3.2`, and pass it to `protoc` via `pbandk`:
Download the latest release, currently `0.4.0`, and pass it to `protoc` via `pbandk`:

```bash
# Download the library to ~
cd ~/
curl -OL https://github.com/collectiveidea/twirp-kmm/releases/download/0.3.2/twirp-kmm-generator-0.3.2.jar
curl -OL https://github.com/collectiveidea/twirp-kmm/releases/download/0.4.0/twirp-kmm-generator-0.4.0.jar
```


Pass the jar and generator class name as the `kotlin_service_gen` option to `pbandk_out`:

```bash
cd ~/exampleProject
protoc --pbandk_out=kotlin_service_gen='~/twirp-kmm-generator-0.3.2.jar|com.collectiveidea.twirp.Generator',kotlin_package=com.example.api:src/main/kotlin src/main/proto/example.proto
protoc --pbandk_out=kotlin_service_gen='~/twirp-kmm-generator-0.4.0.jar|com.collectiveidea.twirp.Generator',kotlin_package=com.example.api:src/main/kotlin src/main/proto/example.proto
```

### Build
Expand All @@ -36,12 +36,12 @@ To build the library locally, run:
./gradlew build
```

This creates the versioned `.jar` file, e.g. `generator/build/libs/twirp-kmm-generator-0.3.2-SNAPSHOT.jar`
This creates the versioned `.jar` file, e.g. `generator/build/libs/twirp-kmm-generator-0.4.0-SNAPSHOT.jar`

Then, the built version can be used, instead of the latest release, by supplying the path to the built `.jar`, e.g.:

```bash
protoc --pbandk_out=kotlin_service_gen='/Users/darron/Development/twirp-kmm/generator/build/libs/twirp-kmm-generator-0.3.2-SNAPSHOT.jar|com.collectiveidea.twirp.Generator',kotlin_package=com.example.api:shared/src/commonMain/kotlin shared/src/commonMain/proto/example.proto
protoc --pbandk_out=kotlin_service_gen='/Users/darron/Development/twirp-kmm/generator/build/libs/twirp-kmm-generator-0.4.0-SNAPSHOT.jar|com.collectiveidea.twirp.Generator',kotlin_package=com.example.api:shared/src/commonMain/kotlin shared/src/commonMain/proto/example.proto
```

## Runtime
Expand All @@ -51,7 +51,7 @@ The runtime provides an [`installTwirp`](./runtime/src/commonMain/kotlin/com/col
First, add the runtime as a dependency:

```
implementation "com.collectiveidea.twirp:twirp-kmm-runtime:0.3.2"
implementation "com.collectiveidea.twirp:twirp-kmm-runtime:0.4.0"
```

Then, configure the HttpClient and pass the client into the generated service constructor:
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version=0.3.2
version=0.4.0
group=com.collectiveidea.twirp

kotlin.code.style=official
Expand Down

2 comments on commit 741ad1d

@aaliomer
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome. When will I be able to see it on maven?

@darronschall
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aaliomer I released this earlier today and already updated to it. https://central.sonatype.com/artifact/com.collectiveidea.twirp/twirp-kmm-runtime

Please sign in to comment.