diff --git a/CHANGELOG.md b/CHANGELOG.md index b0cfd3c2f..d1ba8b6a1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,18 @@ and Yorkie adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) ## [Unreleased] +## [0.4.15] - 2024-03-11 + +### Added +* Add Swagger Serving Command by @devleejb in https://github.com/yorkie-team/yorkie/pull/812 +* Add MongoDB sharding document by @sejongk in https://github.com/yorkie-team/yorkie/pull/781 +* Add merge and split concurrency tests by @justiceHui in https://github.com/yorkie-team/yorkie/pull/780 + +### Fixed +* Prevent RunTestConcurrency from creating garbage clients by @justiceHui in https://github.com/yorkie-team/yorkie/pull/793 +* Add Test Server Wait Helper Function by @krapie in https://github.com/yorkie-team/yorkie/pull/787 +* Update Design Document for Missing Document Link and Instructon by @krapie in https://github.com/yorkie-team/yorkie/pull/782 + ## [0.4.14] - 2024-01-29 ### Added diff --git a/MAINTAINING.md b/MAINTAINING.md index e96b05d68..02db7eeda 100644 --- a/MAINTAINING.md +++ b/MAINTAINING.md @@ -9,7 +9,12 @@ - If `yorkie-monitoring` or `yorkie-argocd` Helm Chart have changes, you also need to update `version` and `appVersion` for each chart. - [yorkie-monitoring Helm Chart](https://github.com/yorkie-team/yorkie/blob/main/build/charts/yorkie-monitoring/Chart.yaml#L14-L15) - [yorkie-argocd Helm Chart](https://github.com/yorkie-team/yorkie/blob/main/build/charts/yorkie-argocd/Chart.yaml#L14-L15) -- Also, you need to update `helmChartTargetRevision` in `yorkie-argocd` Helm Chart's [values.yaml](https://github.com/yorkie-team/yorkie/blob/main/build/charts/yorkie-argocd/values.yaml#L13) +- Update `version`s in API documentation. + - [yorkie.base.yaml](https://github.com/yorkie-team/yorkie/blob/main/api/docs/yorkie.base.yaml#L5) + - [admin.openapi.yaml](https://github.com/yorkie-team/yorkie/blob/main/api/docs/yorkie/v1/admin.openapi.yaml#L6) + - [yorkie.openapi.yaml](https://github.com/yorkie-team/yorkie/blob/main/api/docs/yorkie/v1/yorkie.openapi.yaml#L6) + - [resources.openapi.yaml](https://github.com/yorkie-team/yorkie/blob/main/api/docs/yorkie/v1/resources.openapi.yaml#L6) +- Also, you need to update `helmChartTargetRevision` in `yorkie-argocd` Helm Chart's [values.yaml](https://github.com/yorkie-team/yorkie/blob/main/build/charts/yorkie-argocd/values.yaml#L13) ### 2. Write changelog of this version in [CHANGELOG.md](https://github.com/yorkie-team/yorkie/blob/main/CHANGELOG.md). @@ -21,7 +26,7 @@ Copy the release notes automatically generated by GitHub and categorize them as 4. Click on the `Generate release notes` button. 5. Copy the content generated into the body and categorize each item. -image +image ### 3. Create [Pull Request](https://github.com/yorkie-team/yorkie/commits/main/CHANGELOG.md) for changelog and merge it into main. @@ -29,25 +34,29 @@ Copy the release notes automatically generated by GitHub and categorize them as Executing the following command will generate five zip files for each operating system in the `binaries` folder. -```bash +```bash $ make build-binaries ``` ### 5. Publish [a new release](https://github.com/yorkie-team/yorkie/releases/new). After creating the release in step 2, follow these steps: + 1. Attach the binary files built in step 4. 2. Click on the `Publish release` button. + image -### 6. Deploy +### 6. Deploy #### 1) Docker + When you publish the release in step 5, [GitHub action](https://github.com/yorkie-team/yorkie/blob/main/.github/workflows/docker-publish.yml) will deploy Yorkie to [Docker Hub](https://hub.docker.com/repository/docker/yorkieteam/yorkie). #### 2) Homebrew + Running the command below will automatically create a pull request for deploying to Homebrew. -Once the PR is merged to [homebrew-core](https://github.com/Homebrew/homebrew-core), Yorkie will also be deployed to Homebrew. +Once the PR is merged to [homebrew-core](https://github.com/Homebrew/homebrew-core), Yorkie will also be deployed to Homebrew. ```bash $ brew bump-formula-pr yorkie --tag v{YORKIE_VERSION} diff --git a/Makefile b/Makefile index 50832a69e..f485d638d 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -YORKIE_VERSION := 0.4.14 +YORKIE_VERSION := 0.4.15 GO_PROJECT = github.com/yorkie-team/yorkie diff --git a/api/docs/yorkie.base.yaml b/api/docs/yorkie.base.yaml index c6da8eef8..4763b1298 100644 --- a/api/docs/yorkie.base.yaml +++ b/api/docs/yorkie.base.yaml @@ -2,7 +2,7 @@ openapi: 3.1.0 info: title: Yorkie description: "Yorkie is an open source document store for building collaborative editing applications." - version: v0.4.14 + version: v0.4.15 servers: - url: https://api.yorkie.dev description: Production server diff --git a/api/docs/yorkie/v1/admin.openapi.yaml b/api/docs/yorkie/v1/admin.openapi.yaml index 0f8aa035f..2768f589c 100644 --- a/api/docs/yorkie/v1/admin.openapi.yaml +++ b/api/docs/yorkie/v1/admin.openapi.yaml @@ -3,7 +3,7 @@ info: description: Yorkie is an open source document store for building collaborative editing applications. title: Yorkie - version: v0.4.14 + version: v0.4.15 servers: - description: Production server url: https://api.yorkie.dev diff --git a/api/docs/yorkie/v1/resources.openapi.yaml b/api/docs/yorkie/v1/resources.openapi.yaml index 77af5af37..56939ad32 100644 --- a/api/docs/yorkie/v1/resources.openapi.yaml +++ b/api/docs/yorkie/v1/resources.openapi.yaml @@ -3,7 +3,7 @@ info: description: Yorkie is an open source document store for building collaborative editing applications. title: Yorkie - version: v0.4.14 + version: v0.4.15 servers: - description: Production server url: https://api.yorkie.dev diff --git a/api/docs/yorkie/v1/yorkie.openapi.yaml b/api/docs/yorkie/v1/yorkie.openapi.yaml index 6d5a11c1a..710719a83 100644 --- a/api/docs/yorkie/v1/yorkie.openapi.yaml +++ b/api/docs/yorkie/v1/yorkie.openapi.yaml @@ -3,7 +3,7 @@ info: description: Yorkie is an open source document store for building collaborative editing applications. title: Yorkie - version: v0.4.14 + version: v0.4.15 servers: - description: Production server url: https://api.yorkie.dev diff --git a/build/charts/yorkie-cluster/Chart.yaml b/build/charts/yorkie-cluster/Chart.yaml index d97c532f6..034eaf668 100644 --- a/build/charts/yorkie-cluster/Chart.yaml +++ b/build/charts/yorkie-cluster/Chart.yaml @@ -11,8 +11,8 @@ maintainers: sources: - https://github.com/yorkie-team/yorkie -version: 0.4.14 -appVersion: "0.4.14" +version: 0.4.15 +appVersion: "0.4.15" kubeVersion: ">=1.23.0-0" keywords: