chore: 프로젝트 세팅

[kdomo]

🌱 관련 이슈

• close ⚙️ 프로젝트 세팅 #1

---

📌 작업 내용 및 특이사항

프로젝트 초기 세팅을 진행합니다.

• Issue, Pull Request Template 설정
• 자동 리뷰어 등록을 위한 CodeOwners 설정
• IDE에서 코드 정렬을 위한 .editorconfig 파일 추가
• 코드 포메팅을 위해 CheckStyle 추가
• application.properties에서 application.yml로 변경
• develop 브랜치에 Pull Request시 코드 포메팅 검사와 테스트 진행하기 위한 Workflows 생성

[uwoobeat]

lgtm

[uwoobeat]

@kdomo

이거 밖이라서 제가 잘 못 보고 lgtm 박았는데 지금 확인해보니까 고쳐야 할 부분이 있어서 코멘트 남깁니다~

(1)
워크플로는 develop 브랜치 머지하기 전에 제대로 동작하는지 테스트하려고 만들어두신 것 맞죠?

이 부분은 gradle build로 검증하고, checkStyle 검증의 경우 check 작업에 의존성을 걸어놓고 관리하면 어떨까 싶어요. 애초에 gradle 단에서 발생하는 작업들은 워크플로가 아니라 gradle에서 관리하는 편이 작업 간 의존성 관리하는 데에도 좋거든요.

(check 작업에 대해서는 gradle lifecycle tasks에 대해서 참고해주세요: 레퍼런스)

(2)
추가로 cache 액션 사용하셨는데, gradle-build-action을 사용하면 더 효율적인 캐시 관리가 가능합니다. 이 부분도 참고하시면 좋을 것 같아요~

More sophisticated and more efficient caching of Gradle User Home between invocations, compared to setup-java and most custom configurations using actions/cache. link

[kdomo]

@uwoobeat

(1)
워크플로는 develop 브랜치 머지하기전 제대로 동작하는지 테스트 하려고 만들어 둔게 맞습니다!
재현님이 말씀해주신대로, gradle에서 워크플로우를 관리하는게 훨씬 좋겠네요.
다만, 해당 워크플로에서 build를 해야하는지는 의문입니다!
가능하면 gradle test에 의존성을 걸어두는게 좋다고 생각하는데 어떠세용? 😁

(2)
gradle-build-action이라는게 있군요! 감사합니다🙇🏻

[char-yb]

@kdomo
재현님이 알려주신 gradle-build-action 자체에 gradle wrapper를 이용해서 build를 수행한다고 하네요
참고했던 링크 첨부합니당

@uwoobeat
추가로 위 링크의 cache-read-only 옵션은 main이나 release, develop과 같은 브랜치는 캐싱하고 그 외 브랜치는 real-only로 하는 게 좋다고 하네요 위 내용대로 진행하면 될 거 같은데 어떨까요?

[uwoobeat]

@kdomo @uiurihappy

음 build 작업이 어떻게 수행되는지 방금 보고 왔는데요, check에서 jar 파일 뽑는 과정만 추가되었다고 보면 될 것 같아요. on:pull_request에서는 jar 파일 필요 없으니 check만 쓰면 될 것 같습니다.

++
그리고 test가 아니라 check를 써야하는 이유는 check 작업이 일종의 앵커 역할을 해주는 작업이라 그렇습니다. gradle task에는 lifecycle task와 actionable task가 있는데, 이중 actionable task가 실제로 무언가를 실행하는 작업이고 lifecycle task의 경우 그 자체로는 어떤 것도 실행하지 않지만 다른 task의 의존성을 관리해주는 앵커 역할의 작업이 됩니다.

gradle에서는 check가 대표적인 lifecycle task입니다. check에는 기본적으로 test 작업, 즉 actionable task가 등록되어 있고 만약 여기서 test 외에 통합 테스트 혹은 포매팅 테스트 등이 필요하다면 check에 의존성을 걸어놓고 사용하면 됩니다.

물론 test에 의존적인 작업(가령 api documention 작업)이라면 test에 dependsOn을 걸어주는 것이 맞겠지만, test와 관련이 없는 checkStyle의 경우 check에 걸고 사용하는 것이 맞을 것 같아요.

예전에 TIL에 정리해두었던 내용인데, 참고하시면 좋을 것 같아요.

https://github.com/uwoobeat/today-i-buffered/blob/7b518dbba51075e39e34b6ae2ad30e9f9f9f78a7/230908.md