Skip to content

Commit

Permalink
Update CHANGELOG.md for v0.4.15 (#814)
Browse files Browse the repository at this point in the history
  • Loading branch information
hackerwins authored Mar 11, 2024
1 parent c86999d commit 1445299
Show file tree
Hide file tree
Showing 8 changed files with 33 additions and 13 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
20 changes: 14 additions & 6 deletions MAINTAINING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -21,33 +26,36 @@ 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.

<img width="600" alt="image" src="https://user-images.githubusercontent.com/81357083/233356577-acc1dd33-5ad5-4b51-9f2e-6c771a063ccd.png">
<img width="600" alt="image" src="https://user-images.githubusercontent.com/81357083/233356577-acc1dd33-5ad5-4b51-9f2e-6c771a063ccd.png">

### 3. Create [Pull Request](https://github.com/yorkie-team/yorkie/commits/main/CHANGELOG.md) for changelog and merge it into main.

### 4. Build binaries to attach a new release.

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.
<img width="600" alt="image" src="https://user-images.githubusercontent.com/81357083/233360815-86b723ec-3e63-4640-af1f-e61f61519549.png">
<img width="600" alt="image" src="https://user-images.githubusercontent.com/81357083/233360815-86b723ec-3e63-4640-af1f-e61f61519549.png">

### 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}
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
YORKIE_VERSION := 0.4.14
YORKIE_VERSION := 0.4.15

GO_PROJECT = github.com/yorkie-team/yorkie

Expand Down
2 changes: 1 addition & 1 deletion api/docs/yorkie.base.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion api/docs/yorkie/v1/admin.openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion api/docs/yorkie/v1/resources.openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion api/docs/yorkie/v1/yorkie.openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions build/charts/yorkie-cluster/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 1445299

Please sign in to comment.