How to release new version

This wiki explains how to release rosett-klaytn.
이 wiki는 rosett-klaytn을 릴리즈하는 방법에 대해서 설명합니다.

1. Version update

If all the changes you want to release are merged into the dev branch, update the last release version information to the configuration.go file. According to the above change, the network_service_test.go must also be changed.
릴리즈 하고자하는 변경사항이 모두 dev 브랜치로 머지된 경우, 마지막으로 릴리즈할 버전 정보를 configuration.go 파일에 업데이트한다. 위 변경에 따라 network_service_test.go 의 테스트코드도 변경되어야 한다.

Create a PR containing the above changes, get approved, and merge into the dev branch.
위의 변경사항들을 포함하는 PR을 생성하고 승인받은 후, dev 브랜치에 머지한다.

2. Release rc version

When all changes, including version updates, have been merged into the dev branch, use the script below to release the rc version.
버전 업데이트를 포함한 모든 변경사항이 dev 브랜치로 머지된 경우, 아래 스크립트를 사용하여 rc 버전을 릴리즈한다.

./release_rc.sh

This script tags the version of the rc defined in configuration.go, and if there is already an rc tag in the klaytn/rosetta-klaytn repo, it will tag the most recent rc version + 1. Also, executing the above script automatically creates a PR(ex: v1.0.1) that merges dev changes into the master branch. When the rc version is additionally deployed, the commits are added to the previously created PR.
이 스크립트는 configuration.go 에 정의된 버전의 rc를 태깅하며, 이미 klaytn/rosetta-klaytn 리포에 rc 태그가 있는 경우 가장 최신 rc 버전 + 1로 태깅한다. 또한 위 스크립트를 실행하면 dev 변경사항들이 master 브랜치로 머지하는 PR(예: v1.0.1)이 자동으로 생성된다. rc버전이 추가적으로 배포되면 기존에 만들어진 PR에 커밋이 추가된다.

3. QA

Perform the QA below and record the results.
아래의 QA를 수행하고 결과를 기록한다.

3-1. make test 3-2. make integration-test

The PR with the QA results recorded should be approved by the reviewers.
QA 결과가 기록된 PR을 리뷰어에게 승인을 받는다.

4. Release production version

4-1. Build rosetta-klaytn

When the approved PR is merged, the production version is deployed, and you should build rosetta-klaytn with the command below.
승인된 PR이 머지되면 프로덕션 버전이 배포되며, 아래의 명령어로 rosetta-klaytn을 빌드한다.

git checkout master && git pull upstream master
make build-release -e "version=vx.x.x"

If the machine what you used is Apple M1, use the make build-release-m1 command.
만약 빌드할 때 사용되는 머신이 Apple M1인 경우는 make build-release-m1 명령어를 사용한다.

4-2. Write down release notes

Write a release note and upload the result built above in a compressed form in release assets.
릴리즈 노트https://github.com/klaytn/rosetta-klaytn/releases를 작성하고 release assets에 위에서 빌드된 결과물을 압축된 형태로 함께 업로드한다.