Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CI: 코드 컨벤션 체크 #6

Closed
junha-ahn opened this issue Jul 1, 2023 · 6 comments · Fixed by #17
Closed

CI: 코드 컨벤션 체크 #6

junha-ahn opened this issue Jul 1, 2023 · 6 comments · Fixed by #17
Assignees
Labels
enhancement New feature or request major Major topic

Comments

@junha-ahn
Copy link
Member

junha-ahn commented Jul 1, 2023

Description

코드 컨벤션 체크를 위한 툴을 적용해주세요 (린트, 컨벤션 체크)

To do

  • git actions와 intellij 모두 동작해야합니다.
  • git actions와 intellij 에서 각각의 설정 파일이 존재하는게 아니라, 공통의 설정파일을 이용해주세요.
  • intellij 환경에서는 formet check와 lint 작업을 모두
  • git acitons에서는 최종적으로 format check 결과가 출력되도록 해주세요 (만약 convention을 준수하지 않았다면 오류 메시지 등을 출력해서 PR approve에 정보를 부탁드립니다)
    • 가정) 모든 개발자가 intellij 환경을 쓰지 않으며, 모든 개발자가 lint를 개발단계에서 적용하지 않는다는 가정하에 git actions에 해당 기능을 구현합니다.

Test Checklist

@junha-ahn junha-ahn added the enhancement New feature or request label Jul 1, 2023
@junha-ahn junha-ahn assigned hihahayoung and bohblue2 and unassigned hihahayoung Jul 1, 2023
This was referenced Jul 7, 2023
@bohblue2
Copy link
Collaborator

bohblue2 commented Jul 7, 2023

Local dev env에선 동작하게끔 했습니다만, Github Action에서 ktlint workflow 파일이 PR시마다 안 돌아가는 이유를 모르겠습니다. 리뷰바람.

@junha-ahn
Copy link
Member Author

junha-ahn commented Jul 7, 2023

klint-actions에서는 성공했다고 뜹니다.

#11 PR을 제가 닫았기때문에, 해당 브랜치가 main으로 합쳐지지 않았고, 그렇기 때문에 모든 PR마다 안돌아갑니다.

commit template 준수해서 다시 올려주세요. 자연스럽게 해당 action이 모든 PR마다 돌아갈겁니다.

@junha-ahn
Copy link
Member Author

jobsklint 부분에서 아래와 같은 메세지 뜨는데 확인 부탁드립니다.

reviewdog: This GitHub token doesn't have write permission of Review API [1], 
reviewdog: Reporting results for "ktlint"
so reviewdog will report results via logging command [2] and create annotations similar to
github-pr-check reporter as a fallback.
[1]: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target, 
[2]: https://help.github.com/en/actions/automating-your-workflow-with-github-actions/development-tools-for-github-actions#logging-commands
reviewdog: No results found for "ktlint". 34 results found outside diff.

@junha-ahn junha-ahn assigned junha-ahn and unassigned bohblue2 Jul 8, 2023
@junha-ahn
Copy link
Member Author

assigned @junha-ahn

@junha-ahn
Copy link
Member Author

closed by #17

@junha-ahn junha-ahn linked a pull request Jul 17, 2023 that will close this issue
@junha-ahn junha-ahn added the major Major topic label Aug 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request major Major topic
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants