From 4c6c2d91214c920309c3f6e5ab7207ace97d8cb9 Mon Sep 17 00:00:00 2001 From: Gary Peck Date: Fri, 24 Sep 2021 16:54:50 -0700 Subject: [PATCH] Bump to 0.11.0 --- CHANGELOG.md | 4 ++-- README.md | 11 +++++++---- examples/browser-js/build.gradle.kts | 2 +- examples/custom-service-gen/build.gradle.kts | 2 +- examples/gradle-and-jvm/build.gradle.kts | 2 +- gradle.properties | 2 +- 6 files changed, 13 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 626803a1..15c9c0d0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,9 +5,9 @@ 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.11.0] - Unreleased +## [0.11.0] - 2021-09-24 -[0.11.0]: https://github.com/streem/pbandk/compare/v0.10.0...HEAD +[0.11.0]: https://github.com/streem/pbandk/compare/v0.10.0...v0.11.0 ### Fixed diff --git a/README.md b/README.md index 6fe6c4f3..52c350dd 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,9 @@ Pbandk is a Kotlin code generator and runtime for [Protocol Buffers](https://developers.google.com/protocol-buffers/). It is built to work across multiple Kotlin platforms. -**NOTE**: This is the documentation for the version of pbandk currently in development. **Documentation for the latest stable version** is available at https://github.com/streem/pbandk/blob/v0.10.0/README.md. + **Features** @@ -282,7 +284,7 @@ section below under "Usage" for more details. Pbandk's code generator leverages `protoc`. Download the [latest protoc](https://github.com/google/protobuf/releases/latest) and make sure `protoc` is on the `PATH`. Then download the [latest released protoc-gen-pbandk self-executing jar -file](https://repo1.maven.org/maven2/pro/streem/pbandk/protoc-gen-pbandk-jvm/0.10.0/protoc-gen-pbandk-jvm-0.10.0-jvm8.jar) (if you're using a SNAPSHOT build of pbandk, you might want to instead download the [latest SNAPSHOT version of protoc-gen-pbandk-jvm-\*-jvm8.jar](https://s01.oss.sonatype.org/content/repositories/snapshots/pro/streem/pbandk/protoc-gen-pbandk-jvm/)), +file](https://repo1.maven.org/maven2/pro/streem/pbandk/protoc-gen-pbandk-jvm/0.11.0/protoc-gen-pbandk-jvm-0.11.0-jvm8.jar) (if you're using a SNAPSHOT build of pbandk, you might want to instead download the [latest SNAPSHOT version of protoc-gen-pbandk-jvm-\*-jvm8.jar](https://s01.oss.sonatype.org/content/repositories/snapshots/pro/streem/pbandk/protoc-gen-pbandk-jvm/)), rename it to `protoc-gen-pbandk`, make the file executable (`chmod +x protoc-gen-pbandk`), and make sure it is on the `PATH`. To generate code from `sample.proto` and put the generated code in `src/main/kotlin`, run: @@ -339,7 +341,7 @@ repositories { dependencies { // Can be used from the `common` sourceset in a Kotlin Multiplatform project, // or from platform-specific JVM, Android, JS, or Native sourcesets/projects. - implementation("pro.streem.pbandk:pbandk-runtime:0.11.0-SNAPSHOT") + implementation("pro.streem.pbandk:pbandk-runtime:0.11.0") } ``` @@ -369,7 +371,7 @@ runtime: ``` dependencies { - compileOnly("pro.streem.pbandk:protoc-gen-pbandk-lib:0.11.0-SNAPSHOT") + compileOnly("pro.streem.pbandk:protoc-gen-pbandk-lib:0.11.0") } ``` @@ -588,6 +590,7 @@ To create a new release: 1. Update `CHANGELOG.md`: add a date for the release version, and update the release version's GitHub compare link with a tag instead of `HEAD`. * Note: if you are releasing a pre-release version (alpha, beta, rc) then you don't need to update `CHANGELOG.md` 1. Update the pbandk version number in `gradle.properties`, `README.md`, and `examples/*/build.gradle.kts` to remove the `SNAPSHOT` suffix. For example, if the current version is `0.9.0-SNAPSHOT`, then update it to be `0.9.0`. +1. Comment out the note about the stable version of the documentation that is at the top of `README.md`. 1. Commit the change. E.g.: `git commit -m "Bump to ${VERSION}" -a`. 1. Tag the new version. E.g.: `git tag -a -m "See https://github.com/streem/pbandk/blob/v${VERSION}/CHANGELOG.md" "v${VERSION}"`. diff --git a/examples/browser-js/build.gradle.kts b/examples/browser-js/build.gradle.kts index d6f43a90..79fd1fd6 100644 --- a/examples/browser-js/build.gradle.kts +++ b/examples/browser-js/build.gradle.kts @@ -3,7 +3,7 @@ plugins { id("com.google.protobuf") version "0.8.12" apply false } -val pbandkVersion by extra("0.11.0-SNAPSHOT") +val pbandkVersion by extra("0.11.0") subprojects { repositories { diff --git a/examples/custom-service-gen/build.gradle.kts b/examples/custom-service-gen/build.gradle.kts index 47b704a9..9c485d8a 100644 --- a/examples/custom-service-gen/build.gradle.kts +++ b/examples/custom-service-gen/build.gradle.kts @@ -5,7 +5,7 @@ plugins { id("com.google.protobuf") version "0.8.12" apply false } -val pbandkVersion by extra("0.11.0-SNAPSHOT") +val pbandkVersion by extra("0.11.0") subprojects { repositories { diff --git a/examples/gradle-and-jvm/build.gradle.kts b/examples/gradle-and-jvm/build.gradle.kts index 640af1a0..4d4843a8 100644 --- a/examples/gradle-and-jvm/build.gradle.kts +++ b/examples/gradle-and-jvm/build.gradle.kts @@ -8,7 +8,7 @@ plugins { } val protobufVersion by extra("3.11.1") -val pbandkVersion by extra("0.11.0-SNAPSHOT") +val pbandkVersion by extra("0.11.0") repositories { if (System.getenv("CI") == "true") { diff --git a/gradle.properties b/gradle.properties index 5d05b441..be55b08d 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,5 +1,5 @@ group=pro.streem.pbandk -version=0.11.0-SNAPSHOT +version=0.11.0 kotlin.code.style=official kotlin.mpp.stability.nowarn=true