Skip to content

Commit

Permalink
Prepare version 0.3.1
Browse files Browse the repository at this point in the history
  • Loading branch information
darronschall committed Feb 16, 2023
1 parent 758ee64 commit e98a2ef
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 7 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.3.1] - 2023-02-15

### Fixed

* Generator - Fixed a type issue in generated service code. See [#6](https://github.com/collectiveidea/twirp-kmm/pull/6).

## [0.3.0] - 2023-02-15

### Added
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,20 @@ In general, follow [PBandK Usage](https://github.com/streem/pbandk#usage) instru

### Usage

Download the latest release, currently `0.3.0`, and pass it to `protoc` via `pbandk`:
Download the latest release, currently `0.3.1`, 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.0/twirp-kmm-generator-0.3.0.jar
curl -OL https://github.com/collectiveidea/twirp-kmm/releases/download/0.3.1/twirp-kmm-generator-0.3.1.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.0.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.3.1.jar|com.collectiveidea.twirp.Generator',kotlin_package=com.example.api:src/main/kotlin src/main/proto/example.proto
```

### Build
Expand All @@ -34,12 +34,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.0-SNAPSHOT.jar`
This creates the versioned `.jar` file, e.g. `generator/build/libs/twirp-kmm-generator-0.3.1-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.0-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.3.1-SNAPSHOT.jar|com.collectiveidea.twirp.Generator',kotlin_package=com.example.api:shared/src/commonMain/kotlin shared/src/commonMain/proto/example.proto
```

## Runtime
Expand All @@ -49,7 +49,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.0"
implementation "com.collectiveidea.twirp:twirp-kmm-runtime:0.3.1"
```

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.0
version=0.3.1
group=com.collectiveidea.twirp

kotlin.code.style=official
Expand Down

0 comments on commit e98a2ef

Please sign in to comment.