VIEWER-154 / update README

[LTakhyunKim]

📝 Description

README 내 이전 버전에 해당하는 내용 수정 및 해당 라이브러리의 목적 및 사용법을 상세하게 기입했습니다. 추가된 내용에서 수정이 필요한 사항 혹은 좀 더 추가할 내용이 있다면 코멘트 부탁드립니다.

✔️ PR Type

What kind of change does this PR introduce?

• [ ] Bugfix
• [ ] Feature
• [ ] Code style update (formatting, local variables)
• [ ] Refactoring (no functional changes, no api changes)
• [ ] Chore (non-breaking change which does not affect codebase; Build related changes, version modification, etc.)
• [ ] CI related changes
• [ ] Test Case
• [ ] Performance optimization
• [x] Site/documentation update
• [ ] Other... Please describe:

🎯 Current behavior

구 버전 git clone 주소가 기입되어있습니다.

Issue Number: https://lunit.atlassian.net/browse/VIEWER-154

🚀 New behavior

현재 버전 git clone 주소가 기업되어 있으며, 설치 방법, 라이브러리에 대한 설명이 보다 상세하게 작성되어 있습니다.

💣 Is this a breaking change?

• [ ] Yes
• [x] No

[LTakhyunKim]

nx affected --target=test 를 실행할 경우 작업 범위를 체크하여 워크 스페이스 내 최소 범위를 테스트하는 동작이 현재 github action 실패의 원인으로 보입니다. README 만 수정하여 등록된 프로젝트에 전혀 영향을 주지 않아 테스트를 할 프로젝트가 없고, 이로 인해 report.json 이 export 하지 않아, unit test 에서 에러를 발생시키네요.

이를 해결할 시나리오는 다음과 같습니다.

1. jest coverage github action 을 실행하기 전, npx nx affect target=test --ci --coverage --outputFile=report.json 실행하여 report.json 를 생성합니다.

2. jest coverage github action 을 실행하기 전, report.json 여부를 확인하고, 없을 경우엔 exit 하여 github aciton 을 종료, 있을 경우엔 위 github action 을 실행합니다. 실행할 땐, 이미 생성된 report.json 을 활용합니다. 이미 생성된 report.json 을 활용하는 방법은 기존 테스트 보고서 사용 의 내용을 활용해보려 합니다.

일단 이 부분은 좀 더 찾아보고 적용 여부 결정해보겠습니다. 시나리오 상 문제가 없는지 검토해주시면 감사하겠습니다.

[deminoth]

nx affected --target=test 를 실행할 경우 작업 범위를 체크하여 워크 스페이스 내 최소 범위를 테스트하는 동작이 현재 github action 실패의 원인으로 보입니다. README 만 수정하여 등록된 프로젝트에 전혀 영향을 주지 않아 테스트를 할 프로젝트가 없고, 이로 인해 report.json 이 export 하지 않아, unit test 에서 에러를 발생시키네요.

테스트가 필요한 변경 사항이 없다면 테스트를 진행하지 않는 것이 맞긴 합니다...

[deminoth]

jest coverage github action 을 실행하기 전, report.json 여부를 확인하고, 없을 경우엔 exit 하여 github aciton 을 종료,

앞에 job을 하나 추가해서 nx print-affected등으로 테스트 실행 여부를 먼저 확인하면 될 것 같은데, 당장은 이게 메인 이슈는 아니니 nx run insight-viewer:test로 변경해서 일부 테스트만 수행하도록 하고 PR 마무리하는게 나을수도 있겠습니다.

[LTakhyunKim]

앞에 job을 하나 추가해서 nx print-affected등으로 테스트 실행 여부를 먼저 확인하면 될 것 같은데, 당장은 이게 메인 이슈는 아니니 nx run insight-viewer:test로 변경해서 일부 테스트만 수행하도록 하고 PR 마무리하는게 나을수도 있겠습니다.

넵 알겠습니다 ㅠㅠ... 지금 말씀하신 것과 비슷하게 테스트 실행 후 report.json 생성 여부를 확인하고, jest coverage job 실행 시, if 문으로 체크하는 방식을 적용했는데 의도한대로 동작하진 않네요... nx run insight-viewer:test 로 변경해서 이번 PR 은 마무리하겠습니다.

[github-actions[bot]]

Coverage report

St.:grey_question:	Category	Percentage	Covered / Total
🟢	Statements	92.94%	79/85
🟢	Branches	94.55%	52/55
🟡	Functions	77.78%	21/27
🟢	Lines	92.21%	71/77

Test suite run success

66 tests passing in 9 suites.

Report generated by 🧪jest coverage report action from dd69236986f6dd64721be8be66e78b618eca933e