MAINTAINING.md

Maintaining CodePair

Releasing a New Version

1. Update the version number.

• Update the version field in the root package.json file to reflect the overall version of the monorepo.
• Also, update version fields in the frontend package.json and backend package.json.

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. Publish a new release.

After creating the release in step 2, click on the Publish release button.

5. Deploy

1) Docker

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

2) GitHub Pages

When you publish the release in step 3, GitHub Action will deploy the frontend to GitHub Pages.