코드 품질

CI/CD 파이프라인에 코드 품질 스캐닝 도구와 린터를 통합하기 위한 문서

코드 품질은 기술적 부채가 되기 전에 유지 관리 문제를 식별합니다. 코드 리뷰 중에 발생하는 자동화된 피드백은 팀이 더 나은 코드를 작성하는 데 도움이 됩니다. 결과는 머지 리퀘스트에 직접 표시되어 수정하기에 가장 비용 효율적인 시점에 문제를 볼 수 있게 합니다. 코드 품질은 여러 프로그래밍 언어와 함께 작동하며 일반적인 린터, 스타일 검사기, 복잡성 분석기와 통합됩니다. 기존 도구를 코드 품질 워크플로우에 연결하여 팀의 선호도를 유지하면서 결과 표시 방법을 표준화할 수 있습니다. 티어별 기능 # 다음 표와 같이 다양한 GitLab 티어 에서 다른 기능을 사용할 수 있습니다: 기능 Free에서 Premium에서 Ultimate에서 CI/CD 작업에서 코드 품질 결과 가져오기 ✅ ✅ ✅ CodeClimate 기반 스캔 사용 ✅ ✅ ✅ 머지 리퀘스트 위젯에서 결과 확인 ✅ ✅ ✅ 파이프라인 보고서에서 결과 확인 ❌ ✅ ✅ 머지 리퀘스트 변경 사항 뷰에서 결과 확인 ❌ ❌ ✅ 프로젝트 품질 요약 뷰에서 전반적인 상태 분석 ❌ ❌ ✅ 코드 품질 위반 검사 # 코드 품질은 많은 스캔 도구의 결과를 가져오는 것을 지원하는 개방형 시스템입니다. 위반을 찾아 표면화하려면 다음을 수행할 수 있습니다: 스캐닝 도구를 직접 사용하고 결과를 가져옵니다 . (권장) 내장 CI/CD 템플릿을 사용하여 스캐닝을 활성화합니다. 이 템플릿은 일반적인 오픈 소스 도구를 래핑하는 CodeClimate 엔진을 사용합니다. (더 이상 사용되지 않음) 단일 파이프라인에서 여러 도구의 결과를 캡처할 수 있습니다. 예를 들어, 코드를 스캔하는 코드 린터와 문서를 스캔하는 언어 린터를 실행하거나, 독립형 도구와 CodeClimate 기반 스캔을 함께 사용할 수 있습니다. 코드 품질은 모든 보고서를 결합하므로 결과를 볼 때 모두 표시됩니다. CI/CD 작업에서 코드 품질 결과 가져오기 # 많은 개발 팀이 이미 CI/CD 파이프라인에서 린터, 스타일 검사기 또는 기타 도구를 사용하여 코딩 표준 위반을 자동으로 감지합니다. 이러한 도구의 결과를 코드 품질과 통합하여 더 쉽게 확인하고 수정할 수 있습니다. 도구에 이미 문서화된 통합이 있는지 확인하려면 일반 도구와 코드 품질 통합 을 참조하세요. 다른 도구를 코드 품질과 통합하려면: CI/CD 파이프라인에 도구를 추가합니다. 도구를 구성하여 보고서를 파일로 출력합니다. 이 파일은 특정 JSON 형식 을 사용해야 합니다. 많은 도구가 이 출력 형식을 기본적으로 지원합니다. "CodeClimate 보고서", "GitLab 코드 품질 보고서" 또는 유사한 이름으로 불릴 수 있습니다. 다른 도구는 때로 사용자 정의 JSON 형식 또는 템플릿을 사용하여 JSON 출력을 만들 수 있습니다. 보고서 형식 에는 몇 가지 필수 필드만 있으므로, 이 출력 유형을 사용하여 코드 품질 보고서를 만들 수 있습니다. 이 파일과 일치하는 codequality 보고서 아티팩트 를 선언합니다. 이제 파이프라인이 실행된 후 품질 도구의 결과가 처리되고 표시됩니다 . 내장