MAINTAINING.md

Maintaining Yorkie

Releasing a New Version

1. Update the version number.

• Update YORKIE_VERSION in Makefile.
• Update version and appVersion in yorkie-cluster Helm Chart.
• 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
  • yorkie-argocd Helm Chart
• Update versions in API documentation.
  • yorkie.base.yaml
  • admin.openapi.yaml
  • yorkie.openapi.yaml
  • resources.openapi.yaml
• Also, you need to update helmChartTargetRevision in yorkie-argocd Helm Chart's values.yaml

2. Write changelog of this version in CHANGELOG.md.

Copy the release notes automatically generated by GitHub and categorize them as Added/Changed/Fixed.

1. Click on the Releases in GitHub.
2. Click on the Draft a new release button.
3. Create a new tag.
4. Click on the Generate release notes button.
5. Copy the content generated into the body and categorize each item.

3. Create Pull Request 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.

$ make build-binaries

5. Publish a new release.

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.

6. Deploy

1) Docker

When you publish the release in step 5, GitHub action will deploy Yorkie to Docker Hub.

2) Homebrew

Running the command below will automatically create a pull request for deploying to Homebrew.
Once the PR is merged to homebrew-core, Yorkie will also be deployed to Homebrew.

$ brew bump-formula-pr yorkie --tag v{YORKIE_VERSION}