Link to this section지속적 통합(CI)#
지속적 통합(CI)은 소프트웨어 개발의 필수적인 측면으로, 변경 사항을 통합하고 이를 자동으로 테스트하는 것을 포함합니다. CI를 통해 개발 과정에서 문제를 조기에 자주 발견하여 고품질의 코드를 유지할 수 있습니다. Ultralytics에서는 코드베이스의 품질과 무결성을 보장하기 위해 다양한 CI 테스트를 사용합니다.
Link to this sectionCI 작업#
다음은 저희 CI 작업에 대한 간략한 설명입니다:
- CI: 이는 유닛 테스트, 린팅 검사, 그리고 저장소에 따라 더 포괄적인 테스트를 실행하는 저희의 주요 CI 테스트입니다.
- Docker 배포: 이 테스트는 Docker를 사용하여 프로젝트 배포를 확인하고 Dockerfile 및 관련 스크립트가 올바르게 작동하는지 보장합니다.
- 깨진 링크: 이 테스트는 코드베이스의 마크다운이나 HTML 파일에서 깨지거나 죽은 링크가 있는지 검사합니다.
- CodeQL: CodeQL은 코드에 대한 의미론적 분석을 수행하여 잠재적인 보안 취약점을 찾고 고품질 코드를 유지하도록 돕는 GitHub의 도구입니다.
- PyPI 게시: 이 테스트는 프로젝트가 오류 없이 PyPI에 패키징되고 게시될 수 있는지 확인합니다.
Link to this sectionCI 결과#
다음은 저희 메인 저장소에 대한 CI 테스트 상태를 보여주는 표입니다:
| 저장소 | CI | Docker 배포 | 깨진 링크 | CodeQL | PyPI 및 문서 게시 |
|---|---|---|---|---|---|
| yolov3 |  |  |  |  | |
| yolov5 |  |  |  |  | |
| ultralytics |  |  |  |  |   |
| yolo-ios-app (App Store) |  |  |  | ||
| yolo-flutter-app |  |  |  | ||
| hub |  |  | |||
| hub-sdk |  |  |  |  | |
| thop |  |  |  | ||
| actions |  |  |  | ||
| mkdocs |  |  |  | ||
| docs |  |   |  | ||
| handbook |  |  |  | ||
| stars |  |  | |||
| CLIP |  |
각 배지는 해당 저장소의 main 브랜치에서 CI 테스트가 마지막으로 실행된 상태를 보여줍니다. 테스트가 실패하면 배지는 "실패" 상태를 표시하고, 성공하면 "성공" 상태를 표시합니다.
테스트 실패를 발견하시면 해당 저장소의 GitHub 이슈를 통해 신고해 주시면 큰 도움이 됩니다.
성공적인 CI 테스트가 모든 것이 완벽하다는 것을 의미하지는 않는다는 점을 기억하십시오. 배포나 변경 사항을 병합하기 전에 항상 코드를 수동으로 검토하는 것을 권장합니다.
Link to this section코드 커버리지#
코드 커버리지는 테스트가 실행될 때 코드베이스의 몇 퍼센트가 실행되는지를 나타내는 지표입니다. 이는 테스트가 코드를 얼마나 잘 검증하는지에 대한 통찰력을 제공하며, 애플리케이션의 테스트되지 않은 부분을 식별하는 데 결정적인 역할을 할 수 있습니다. 높은 코드 커버리지 비율은 종종 버그 발생 가능성이 낮다는 것과 연관됩니다. 그러나 코드 커버리지가 결함이 없음을 보장하지는 않는다는 점을 이해하는 것이 중요합니다. 이는 단지 테스트에 의해 실행된 코드의 일부를 나타낼 뿐입니다.
Link to this sectioncodecov.io와의 통합#
Ultralytics는 코드 커버리지를 측정하고 시각화하기 위한 인기 있는 온라인 플랫폼인 codecov.io와 저장소를 통합했습니다. Codecov는 자세한 통찰력, 커밋 간 커버리지 비교, 그리고 코드에 직접적인 시각적 오버레이를 제공하여 어떤 라인이 커버되었는지 표시합니다.
Codecov와의 통합을 통해 오류가 발생하기 쉽거나 추가 테스트가 필요한 영역에 집중함으로써 코드 품질을 유지하고 개선하는 것을 목표로 합니다.
Link to this section커버리지 결과#
ultralytics Python 패키지의 코드 커버리지 상태를 빠르게 파악하기 위해, ultralytics 커버리지 결과에 대한 배지와 썬버스트 시각 자료를 포함했습니다. 이 이미지들은 테스트에 의해 커버된 코드의 비율을 보여주며, 저희 테스트 노력에 대한 한눈에 볼 수 있는 지표를 제공합니다. 자세한 내용은 Ultralytics Codecov 보고서를 방문하십시오.
| 저장소 | 코드 커버리지 |
|---|---|
| ultralytics |  |
아래 썬버스트 그래픽에서 가장 안쪽 원은 전체 프로젝트를 나타내며, 중심에서 멀어질수록 폴더, 마지막으로 단일 파일 순입니다. 각 조각의 크기와 색상은 각각 구문 수와 커버리지를 나타냅니다.
Link to this sectionFAQ#
Link to this sectionUltralytics에서 지속적 통합(CI)이란 무엇인가요?#
Ultralytics의 지속적 통합(CI)은 높은 품질 표준을 보장하기 위해 코드 변경 사항을 자동으로 통합하고 테스트하는 것을 포함합니다. 저희 CI 설정에는 유닛 테스트, 린팅 검사 및 포괄적인 테스트 실행이 포함됩니다. 또한, Docker 배포, 깨진 링크 검사, 보안 취약점을 위한 CodeQL 분석, 그리고 소프트웨어를 패키징하고 배포하기 위한 PyPI 게시를 수행합니다.
Link to this sectionUltralytics는 문서와 코드에서 깨진 링크를 어떻게 확인하나요?#
Ultralytics는 마크다운 및 HTML 파일 내의 깨진 링크를 확인하기 위해 특정 CI 작업을 사용합니다. 이는 죽었거나 깨진 링크를 스캔하고 식별하여 문서의 무결성을 유지하는 데 도움을 주며, 사용자가 항상 정확하고 살아있는 리소스에 액세스할 수 있도록 보장합니다.
Link to this sectionUltralytics 코드베이스에서 CodeQL 분석이 중요한 이유는 무엇인가요?#
CodeQL 분석은 잠재적인 보안 취약점을 찾고 높은 품질 표준을 유지하기 위해 의미론적 코드 분석을 수행하므로 Ultralytics에 중요합니다. CodeQL을 통해 코드의 위험을 선제적으로 식별하고 완화하여 견고하고 안전한 소프트웨어 솔루션을 제공할 수 있도록 돕습니다.
Link to this sectionUltralytics는 배포를 위해 Docker를 어떻게 활용하나요?#
Ultralytics는 전용 CI 작업을 통해 프로젝트 배포를 검증하기 위해 Docker를 사용합니다. 이 과정은 Dockerfile 및 관련 스크립트가 올바르게 작동하는지 보장하며, 확장 가능하고 신뢰할 수 있는 AI 솔루션에 필수적인 일관되고 재현 가능한 배포 환경을 가능하게 합니다.
Link to this sectionUltralytics에서 자동화된 PyPI 게시의 역할은 무엇인가요?#
자동화된 PyPI 게시는 저희 프로젝트가 오류 없이 패키징되고 게시될 수 있도록 합니다. 이 단계는 Ultralytics의 Python 패키지를 배포하는 데 필수적이며, 사용자가 Python Package Index (PyPI)를 통해 도구를 쉽게 설치하고 사용할 수 있도록 합니다.
Link to this sectionUltralytics는 코드 커버리지를 어떻게 측정하며 왜 중요한가요?#
Ultralytics는 Codecov와 통합하여 코드 커버리지를 측정하며, 테스트 중에 코드베이스의 어느 정도가 실행되는지에 대한 통찰력을 제공합니다. 높은 코드 커버리지는 잘 테스트된 코드를 나타낼 수 있으며, 버그가 발생하기 쉬운 테스트되지 않은 영역을 발견하는 데 도움을 줍니다. 자세한 코드 커버리지 메트릭은 메인 저장소에 표시된 배지나 Codecov에서 직접 확인할 수 있습니다.