Add release notes for 1.18.0 (#4375)

* initial commit * reran release-notes * first draft * naming for graphql * add endpoint selection bugfix * update the release date * Update site/src/pages/release-notes/1.18.0.mdx Co-authored-by: Ikhun Um <ih.pert@gmail.com> * Update site/src/pages/release-notes/1.18.0.mdx Co-authored-by: Ikhun Um <ih.pert@gmail.com> * Update site/src/pages/release-notes/1.18.0.mdx Co-authored-by: Ikhun Um <ih.pert@gmail.com> * Update site/src/pages/release-notes/1.18.0.mdx Co-authored-by: Ikhun Um <ih.pert@gmail.com> * Update site/src/pages/release-notes/1.18.0.mdx Co-authored-by: Ikhun Um <ih.pert@gmail.com> * Update site/src/pages/release-notes/1.18.0.mdx Co-authored-by: Ikhun Um <ih.pert@gmail.com> * Update site/src/pages/release-notes/1.18.0.mdx Co-authored-by: Ikhun Um <ih.pert@gmail.com> * address comments by @ikhoon * update dependencies * ignore CLAassistant when aggregating users * grammatical mistake * address comments by @ikhoon * Update site/src/pages/release-notes/1.18.0.mdx Co-authored-by: minux <songmw725@gmail.com> * Update site/src/pages/release-notes/1.18.0.mdx Co-authored-by: minux <songmw725@gmail.com> * Update site/src/pages/release-notes/1.18.0.mdx Co-authored-by: minux <songmw725@gmail.com> * Update site/src/pages/release-notes/1.18.0.mdx Co-authored-by: minux <songmw725@gmail.com> * Update site/src/pages/release-notes/1.18.0.mdx Co-authored-by: minux <songmw725@gmail.com> * Update site/src/pages/release-notes/1.18.0.mdx Co-authored-by: minux <songmw725@gmail.com> * Update site/src/pages/release-notes/1.18.0.mdx Co-authored-by: minux <songmw725@gmail.com> * address comments by @minwoox * align indices for code blocks * Update site/src/pages/release-notes/1.18.0.mdx Co-authored-by: Ikhun Um <ih.pert@gmail.com> Co-authored-by: minux <songmw725@gmail.com>
line · Aug 8, 2022 · de36a8b · de36a8b
1 parent ac456e9
commit de36a8b
Show file tree

Hide file tree

Showing 4 changed files with 132 additions and 5 deletions.
diff --git a/site/release-note.ts b/site/release-note.ts
@@ -258,6 +258,7 @@ function renderReleaseNotes(pullRequests: PullRequest[]): string {
     .flatMap((pr) => pr.users)
     .sortBy()
     .uniq()
+    .filter((user) => user !== "CLAassistant")
     .map((user) => `  '${user}'`)
     .join(',\n')
     .value();

diff --git a/site/src/pages/community/developer-guide.mdx b/site/src/pages/community/developer-guide.mdx
@@ -2,10 +2,9 @@
 
 ## Build requirements
 
-- [OpenJDK 11-16](https://adoptopenjdk.net/archive.html?variant=openjdk16&jvmVariant=hotspot) (*not* 17)
-  - Consider using a version manager for convenient installation of JDK, such as:
-    - [asdf](https://asdf-vm.com/) - `asdf plugin add java && asdf install java adoptopenjdk-16.0.2+7`
-    - [jabba](https://github.com/shyiko/jabba) - `jabba install adopt@1.16.0-1`
+- [OpenJDK 11-17](https://adoptopenjdk.net/archive.html?variant=openjdk17&jvmVariant=hotspot)
+  - Consider using a version manager for convenient installation of JDK, such as
+    [asdf](https://asdf-vm.com/) and [jabba](https://github.com/shyiko/jabba).
 
 ## How to build
 

diff --git a/site/src/pages/release-notes/1.17.2.mdx b/site/src/pages/release-notes/1.17.2.mdx
@@ -5,7 +5,7 @@ date: 2022-08-02
 ## 🛠️ Bug fixes
 
 - CORS requests with query params are handled correctly. #4378
-  - Armeria versions from 1.15.0 to 1.17.0 are affected.
+  - Armeria versions from 1.15.0 to 1.17.1 are affected.
 
 ## 🙇 Thank you
 

diff --git a/site/src/pages/release-notes/1.18.0.mdx b/site/src/pages/release-notes/1.18.0.mdx
@@ -0,0 +1,127 @@
+---
+date: 2022-08-08
+---
+
+## 🌟 New features
+
+- <type://DocService> can now render Markdown and [Mermaid](https://mermaid-js.github.io/mermaid/)
+  formatted documentation for annotated services. #4299 #4304
+
+  ```java
+  @Description(value = "### Markdown format", markup = Markup.MARKDOWN)
+  @Get("/markdown")
+  public HttpResponse markdown() {
+    return HttpResponse.of(200);
+  }
+  ```
+
+  ```java
+  @Description(value = "graph TD;\n" +
+                       " A-->B;\n" +
+                       " A-->C;\n" +
+                       " B-->D;\n" +
+                       " C-->D;",
+               markup = Markup.MERMAID)
+  @Get("/mermaid")
+  public HttpResponse mermaid() {
+    return HttpResponse.of(200);
+  }
+  ```
+
+- You can now bind decorators to each gRPC service using <type://GrpcServiceBuilder#addService(BindableService,Iterable)>. #4311 #4316
+
+  ```java
+  GrpcService.builder()
+    .addService(myGrpcService, List.of(decorator)) // 👈👈👈
+    .build();
+  ```
+
+- <type://UnframedGrpcErrorHandler#ofJson()> now conforms to
+  [Google's error model](https://cloud.google.com/apis/design/errors#error_model).
+
+  ```java
+  GrpcService
+    .builder()
+    .addService(myGrpcServiceImpl)
+    .unframedGrpcErrorHandler(
+      UnframedGrpcErrorHandler.ofJson()) // 👈👈👈
+    .build();
+  ```
+
+  ```json
+  {
+    "code": 2,
+    "message": "A custom message!",
+    ...
+  }
+  ```
+
+- You can now extract the innermost element of <type://Unwrappable> type objects easily using <type://Unwrappable#unwrapAll()>. #4338
+
+  ```java
+  Foo foo = new Foo();
+  Bar<Foo> bar = new Bar<>(foo);
+  Qux<Bar<Foo>> qux = new Qux<>(bar);
+  assert qux.unwrapAll() == foo; // 👈👈👈
+  ```
+
+## 📈 Improvements
+
+- <type://RequestContext> now extends <type://Unwrappable>. #4308
+
+## 🛠️ Bug fixes
+
+- You no longer see an intermittent <type://IllegalStateException> for gRPC services
+  when <type://GrpcServiceBuilder#useBlockingTaskExecutor(boolean)> is enabled. #4367 #4374
+- Requests no longer hang when gRPC-JSON transcoding is enabled and gRPC decorators return an unframed response. #4337 #4348
+- You can now use <type://HttpFile> to serve files from the OSGI bundle. #4371 #4373
+- A request's start time on the server side is now correctly
+  recorded when a server receives the first header. #4365 #4372
+- You no longer see a false positive warning of unknown `MethodType` when using gRPC clients. #4363
+- You no longer see a `NoSuchElementException` while a <type://HealthCheckedEndpointGroup> is closed. #4349
+- <type://ClosedSessionException> and <type://ClosedStreamException> are raised correctly according to their usage. #4380
+- The timeout for client's endpoint selection isn't clamped by `responseTimeout` anymore. #4383
+
+## ⛓ Dependencies
+
+- Brave 5.13.9 → 5.13.10
+- Bucket4j 7.5.0 → 7.6.0
+- Curator 5.2.1 → 5.3.0
+- Dropwizard metrics 2.1.0 → 2.1.1
+- GraphQL-Java 18.2 → 19.0
+- GraphQL-Kotlin 5.3.2 → 6.1.0
+- gRPC-Java 1.47.0 → 1.48.0
+- java-jwt 3.19.1 → 4.0.0
+- Jetty 9.4.46.v20220331 → 9.4.48.v20220622
+- kafka-clients 3.2.0 → 3.2.1
+- Kotlin 1.7.0 → 1.7.10
+- Kotlin Coroutine 1.6.3 → 1.6.4
+- Micrometer 1.9.1 → 1.9.2
+- Netty 4.1.78.Final → 4.1.79.Final
+- Protobuf 3.19.2 → 3.21.1
+- Reactor 3.4.19 → 3.4.21
+- RESTEasy 5.0.2.Final → 5.0.4.Final
+- Sangria 3.0.0 → 3.0.1
+- Scala 2.12.15 → 2.12.16, 3.1.2 → 3.1.3
+- scala-collection-compat 2.7.0 → 2.8.1
+- Spring Boot 2.7.1 → 2.7.2
+- Spring Web 5.3.21 → 5.3.22
+- Tomcat8 8.5.78 → 8.5.81
+- Tomcat9 9.0.62 → 9.0.65
+
+## 🙇 Thank you
+
+<ThankYou usernames={[
+  'anuraaga',
+  'cnabro',
+  'ikhoon',
+  'j-min5u',
+  'jrhee17',
+  'mauhiz',
+  'minwoox',
+  'natsumehu',
+  'ngyukman',
+  'proceane',
+  'ta7uw',
+  'trustin'
+]} />